Api Management Service - Backup

Tworzy kopię zapasową usługi API Management dla danego konta usługi Azure Storage. Ta operacja trwa długo i może potrwać kilka minut.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backup?api-version=2021-08-01

Parametry identyfikatora URI

Name In Required Type Description
resourceGroupName
path True
  • string

Nazwa grupy zasobów.

serviceName
path True
  • string

Nazwa usługi API Management.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Poświadczenia subskrypcji, które jednoznacznie identyfikują Microsoft Azure subskrypcji. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.

api-version
query True
  • string

Wersja interfejsu API do użycia z żądaniem klienta.

Treść żądania

Name Required Type Description
backupName True
  • string

Nazwa pliku kopii zapasowej do utworzenia/pobrania.

containerName True
  • string

Nazwa kontenera obiektów blob (używana do umieszczania/pobierania kopii zapasowej).

storageAccount True
  • string

Nazwa konta usługi Azure Storage (używana do umieszczania/pobierania kopii zapasowej).

accessKey
  • string

Storage klucz dostępu do konta. Wymagane tylko wtedy, gdy accessType ustawiono wartość AccessKey.

accessType

Typ dostępu do użycia dla konta magazynu.

clientId
  • string

Identyfikator klienta tożsamości zarządzanej przypisanej przez użytkownika. Wymagane tylko wtedy, gdy accessType ustawiono wartość UserAssignedManagedIdentity.

Odpowiedzi

Name Type Description
200 OK

Pomyślnie utworzono kopię zapasową usługi API Management na koncie magazynu.

202 Accepted

Zaakceptowane: Nagłówek lokalizacji zawiera adres URL, w którym można sprawdzić stan długotrwałej operacji.

Other Status Codes

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

Zabezpieczenia

azure_auth

Azure Active Directory Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation personifikacja konta użytkownika

Przykłady

ApiManagementBackupWithAccessKey
ApiManagementBackupWithSystemManagedIdentity
ApiManagementBackupWithUserAssignedManagedIdentity

ApiManagementBackupWithAccessKey

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backup?api-version=2021-08-01

{
  "storageAccount": "teststorageaccount",
  "containerName": "backupContainer",
  "backupName": "apimService1backup_2017_03_19",
  "accessType": "AccessKey",
  "accessKey": "**************************************************"
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2021-08-01
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "West US",
  "etag": "AAAAAAACXok=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-18T06:26:20.3348609Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-westus-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
      },
      {
        "type": "Proxy",
        "hostName": "gateway1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      }
    ],
    "publicIPAddresses": [
      "13.91.32.113"
    ],
    "additionalLocations": [
      {
        "location": "East US",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "publicIPAddresses": [
          "23.101.138.153"
        ],
        "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net",
        "disableGateway": true
      }
    ],
    "customProperties": {
      "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.Ciphers.TripleDes168": "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": "None",
    "disableGateway": false,
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}

ApiManagementBackupWithSystemManagedIdentity

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backup?api-version=2021-08-01

{
  "storageAccount": "contosorpstorage",
  "containerName": "apim-backups",
  "backupName": "backup5",
  "accessType": "SystemAssignedManagedIdentity"
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2021-08-01
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "apimService1"
  },
  "location": "Central US EUAP",
  "etag": "AAAAAAAQM8o=",
  "properties": {
    "publisherEmail": "apimService1@corp.microsoft.com",
    "publisherName": "MS",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2020-04-23T16:26:47.8637967Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-centraluseuap-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": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "publicIPAddresses": [
      "52.XXXX.160.66"
    ],
    "customProperties": {
      "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.Ciphers.TripleDes168": "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": "None",
    "disableGateway": false,
    "publicNetworkAccess": "Enabled",
    "platformVersion": "stv1"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "XXXXX-5fb4-4916-95d4-64b306f9d924",
    "tenantId": "XXXXX-86f1-XXXXX-91ab-2d7cd011db47",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": {
        "principalId": "XXXXX-a100-4478-XXXX-d65d98118ba0",
        "clientId": "XXXXX-a154-4830-XXXX-46a12da1a1e2"
      },
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": {
        "principalId": "XXXXX-9208-4128-af2d-a10d2af9b5a3",
        "clientId": "XXXX-6328-4db2-XXXX-ab0e3e7806cf"
      }
    }
  },
  "systemData": {
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-06-30T06:24:57.0008037Z"
  }
}

ApiManagementBackupWithUserAssignedManagedIdentity

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backup?api-version=2021-08-01

{
  "storageAccount": "contosorpstorage",
  "containerName": "apim-backups",
  "backupName": "backup5",
  "accessType": "UserAssignedManagedIdentity",
  "clientId": "XXXXX-a154-4830-XXXX-46a12da1a1e2"
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2021-08-01
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "apimService1"
  },
  "location": "Central US EUAP",
  "etag": "AAAAAAAQM8o=",
  "properties": {
    "publisherEmail": "apimService1@corp.microsoft.com",
    "publisherName": "MS",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2020-04-23T16:26:47.8637967Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-centraluseuap-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": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "publicIPAddresses": [
      "52.XXXX.160.66"
    ],
    "customProperties": {
      "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.Ciphers.TripleDes168": "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": "None",
    "disableGateway": false,
    "publicNetworkAccess": "Enabled",
    "platformVersion": "stv1"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "XXXXX-5fb4-4916-95d4-64b306f9d924",
    "tenantId": "XXXXX-86f1-XXXXX-91ab-2d7cd011db47",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": {
        "principalId": "XXXXX-a100-4478-XXXX-d65d98118ba0",
        "clientId": "XXXXX-a154-4830-XXXX-46a12da1a1e2"
      },
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": {
        "principalId": "XXXXX-9208-4128-af2d-a10d2af9b5a3",
        "clientId": "XXXX-6328-4db2-XXXX-ab0e3e7806cf"
      }
    }
  },
  "systemData": {
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-06-30T06:24:57.0008037Z"
  }
}

Definicje

AccessType

Typ dostępu do użycia dla konta magazynu.

AdditionalLocation

Opis dodatkowej lokalizacji zasobu API Management.

ApiManagementServiceBackupRestoreParameters

Parametry dostarczane do operacji tworzenia/przywracania kopii zapasowej 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 Uzyskiwanie odpowiedzi.

ApiManagementServiceSkuProperties

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

ApimIdentityType

Typ tożsamości używanej 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 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 składająca się z nie zaufanych pośrednich i certyfikatów głównych.

CertificateInformation

Informacje o certyfikacie SSL.

CertificateSource

Źródło certyfikatu.

CertificateStatus

Stan certyfikatu.

createdByType

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

ErrorFieldContract

Błąd Kontrakt pola.

ErrorResponse

Odpowiedź na błąd.

HostnameConfiguration

Niestandardowa konfiguracja nazwy hosta.

HostnameType

Typ nazwy hosta.

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

Niezależnie od tego, 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ść "Wyłączone", prywatne punkty końcowe są metodą wyłącznego 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ą żadnego Virtual Network, zewnętrzne oznacza, że wdrożenie API Management jest skonfigurowane wewnątrz Virtual Network mającego internetowy punkt końcowy, a wewnętrzny oznacza, że API Management wdrożenie jest konfigurowane w Virtual Network tylko w punkcie końcowym dostępnym w intranecie.

AccessType

Typ dostępu do użycia dla konta magazynu.

Name Type Description
AccessKey
  • string

Użyj klucza dostępu.

SystemAssignedManagedIdentity
  • string

Użyj tożsamości zarządzanej przypisanej przez system.

UserAssignedManagedIdentity
  • string

Użyj tożsamości zarządzanej przypisanej przez użytkownika.

AdditionalLocation

Opis dodatkowej lokalizacji zasobu API Management.

Name Type Default Value Description
disableGateway
  • boolean
False

Właściwość jest 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.

platformVersion

Wersja platformy obliczeniowej z uruchomioną usługą.

privateIPAddresses
  • string[]

Prywatne statyczne adresy IP usługi API Management wdrożonej w wewnętrznej Virtual Network 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 standardowy adres IP jednostki SKU w wersji 4, który ma być skojarzony z Virtual Network wdrożonej usługi w lokalizacji. Obsługiwane tylko w przypadku jednostki SKU Premium wdrażanej w Virtual Network.

sku

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

virtualNetworkConfiguration

Konfiguracja sieci wirtualnej dla lokalizacji.

zones
  • string[]

Lista stref dostępności oznaczających miejsce, z którego musi pochodzić zasób.

ApiManagementServiceBackupRestoreParameters

Parametry dostarczane do operacji tworzenia/przywracania kopii zapasowej usługi API Management.

Name Type Default Value Description
accessKey
  • string

Storage klucz dostępu do konta. Wymagane tylko wtedy, gdy accessType jest ustawiona wartość AccessKey.

accessType AccessKey

Typ dostępu, który ma być używany dla konta magazynu.

backupName
  • string

Nazwa pliku kopii zapasowej do utworzenia/pobrania.

clientId
  • string

Identyfikator klienta tożsamości zarządzanej przypisanej przez użytkownika. Wymagane tylko wtedy, gdy accessType jest ustawiona wartość UserAssignedManagedIdentity.

containerName
  • string

Nazwa kontenera obiektów blob (używana do umieszczania/pobierania kopii zapasowej).

storageAccount
  • string

Nazwa konta usługi Azure Storage (używana do umieszczania/pobierania kopii zapasowej).

ApiManagementServiceIdentity

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

Name Type Description
principalId
  • string

Identyfikator podmiotu zabezpieczeń tożsamości.

tenantId
  • string

Identyfikator dzierżawy klienta tożsamości.

type

Typ tożsamości używanej 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

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

Pojedynczy zasób usługi API Management w obszarze Lista lub Uzyskiwanie odpowiedzi.

Name Type Default Value Description
etag
  • string

Element ETag zasobu.

id
  • string

Identyfikator zasobu.

identity

Tożsamość usługi zarządzanej usługi Api Management.

location
  • string

Lokalizacja zasobu.

name
  • string

Nazwa zasobu.

properties.additionalLocations

Dodatkowe lokalizacje centrum danych usługi API Management.

properties.apiVersionConstraint

Ograniczenie wersji interfejsu API płaszczyzny sterowania dla usługi API Management.

properties.certificates

Lista certyfikatów, które należy zainstalować w usłudze API Management. Maksymalna obsługiwana liczba certyfikatów, które można zainstalować, wynosi 10.

properties.createdAtUtc
  • string

Data utworzenia czasu 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 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ż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 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 zapleczami.
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 operacji PATCH spowoduje zresetowanie wartości właściwości do ich wartości domyślnych. Dla wszystkich ustawień z wyjątkiem Http2 wartość domyślna toTrue, jeśli usługa została utworzona w dniu 1 kwietnia 2018 r. lub wcześniej.False Wartość domyślna ustawienia Http2 to False.

Możesz wyłączyć dowolne kolejne szyfry 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: nie można wyłączyć następnych szyfrów, ponieważ są one wymagane przez wewnętrzne składniki usługi Azure CloudService: 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,TLS_RSA_WITH_AES_256_GCM_SHA384

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ż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

Niestandardowa konfiguracja nazwy hosta usługi API Management.

properties.managementApiUrl
  • string

Adres URL punktu końcowego interfejsu API zarządzania usługi API Management.

properties.notificationSenderEmail
  • string

Adres e-mail, z którego zostanie wysłane powiadomienie.

properties.platformVersion

Wersja platformy obliczeniowej z uruchomioną usługą w tej lokalizacji.

properties.portalUrl
  • string

Publisher adres URL punktu końcowego portalu usługi API Management.

properties.privateEndpointConnections

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 Virtual Network. 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óra może być jedną z następujących wartości: 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 adres IP jednostki SKU w wersji 4, który ma być skojarzony z usługą wdrożona Virtual Network w regionie. Obsługiwane tylko w przypadku jednostek SKU deweloperów i Premium wdrażanych w Virtual Network.

properties.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ą metodą wyłącznego dostępu. Wartość domyślna to "Włączone"

properties.publisherEmail
  • string

Publisher wiadomości e-mail.

properties.publisherName
  • string

Publisher nazwa.

properties.restore
  • boolean
False

Cofanie usuwania usługi Api Management, jeśli została wcześniej usunięta nietrwale. Jeśli ta flaga zostanie 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

Konfiguracja sieci wirtualnej usługi API Management.

properties.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ą żadnego Virtual Network, zewnętrzne oznacza, że wdrożenie API Management jest skonfigurowane wewnątrz Virtual Network mającego punkt końcowy dostępny z Internetu, a wewnętrzny oznacza, że API Management wdrożenie jest konfigurowane w Virtual Network tylko z punktem końcowym dostępnym w intranecie.

sku

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

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

tags
  • object

Tagi zasobów.

type
  • string

Typ zasobu API Management jest ustawiony na Wartość Microsoft.ApiManagement.

zones
  • string[]

Lista stref dostępności oznaczających, skąd musi pochodzić zasób.

ApiManagementServiceSkuProperties

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

Name Type Description
capacity
  • integer

Pojemność jednostki SKU (liczba wdrożonych jednostek SKU). W przypadku pojemności jednostki SKU zużycie należy określić wartość 0.

name

Nazwa jednostki SKU.

ApimIdentityType

Typ tożsamości używanej 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 tożsamości z usługi.

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned, UserAssigned
  • string
UserAssigned
  • string

ApiVersionConstraint

Ograniczenie wersji interfejsu API płaszczyzny sterowania dla usługi API Management.

Name Type Description
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

Otoka identyfikatora zasobu usługi ARM

Name Type Description
id
  • string

CertificateConfiguration

Konfiguracja certyfikatu składająca się z nie zaufanych pośrednich i certyfikatów głównych.

Name Type Description
certificate

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. Tylko root i CertificateAuthority są prawidłowe lokalizacje.

CertificateInformation

Informacje o certyfikacie SSL.

Name Type Description
expiry
  • string

Data wygaśnięcia certyfikatu. Data jest zgodna z następującym formatem: yyyy-MM-ddTHH:mm:ssZ zgodnie z normą ISO 8601.

subject
  • string

Podmiot certyfikatu.

thumbprint
  • string

Odcisk palca certyfikatu.

CertificateSource

Źródło certyfikatu.

Name Type Description
BuiltIn
  • string
Custom
  • string
KeyVault
  • string
Managed
  • string

CertificateStatus

Stan certyfikatu.

Name Type Description
Completed
  • string
Failed
  • string
InProgress
  • string

createdByType

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

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorFieldContract

Błąd Kontrakt pola.

Name Type Description
code
  • string

Kod błędu poziomu właściwości.

message
  • string

Czytelna dla człowieka reprezentacja błędu na poziomie właściwości.

target
  • string

Nazwa właściwości.

ErrorResponse

Odpowiedź na błąd.

Name Type Description
error.code
  • string

Kod błędu zdefiniowany przez usługę. Ten kod służy jako podstan kodu błędu HTTP określonego w odpowiedzi.

error.details

Lista nieprawidłowych pól jest wysyłana w żądaniu w przypadku błędu walidacji.

error.message
  • string

Czytelna dla człowieka reprezentacja błędu.

HostnameConfiguration

Niestandardowa konfiguracja nazwy hosta.

Name Type Default Value Description
certificate

Informacje o certyfikacie.

certificatePassword
  • string

Hasło certyfikatu.

certificateSource

Źródło certyfikatu.

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 serwera proxy.

encodedCertificate
  • string

Certyfikat zakodowany w formacie Base64.

hostName
  • string

Nazwa hosta do skonfigurowania w usłudze Api Management.

identityClientId
  • string

Identyfikator clientId przypisanej przez system lub użytkownika tożsamości zarządzanej wygenerowany przez 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 podano 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

Typ nazwy hosta.

HostnameType

Typ nazwy hosta.

Name Type Description
DeveloperPortal
  • string
Management
  • string
Portal
  • string
Proxy
  • string
Scm
  • string

PlatformVersion

Wersja platformy obliczeniowej z uruchomioną usługą.

Name Type Description
mtv1
  • string

Platforma z uruchomioną usługą na platformie Multi Tenant V1.

stv1
  • string

Platforma z uruchomioną usługą na platformie Single Tenant V1.

stv2
  • string

Platforma z uruchomioną usługą na platformie Single Tenant V2.

undetermined
  • string

Nie można określić wersji platformy, ponieważ platforma obliczeniowa nie jest wdrożona.

PrivateEndpointServiceConnectionStatus

Stan połączenia prywatnego punktu końcowego.

Name Type Description
Approved
  • string
Pending
  • string
Rejected
  • string

PrivateLinkServiceConnectionState

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

Name Type Description
actionsRequired
  • string

Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji dla konsumenta.

description
  • string

Przyczyna zatwierdzenia/odrzucenia połączenia.

status

Wskazuje, czy połączenie zostało zatwierdzone/odrzucone/usunięte przez właściciela usługi.

PublicNetworkAccess

Niezależnie od tego, 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ść "Wyłączone", prywatne punkty końcowe są metodą wyłącznego dostępu. Wartość domyślna to "Włączone"

Name Type Description
Disabled
  • string
Enabled
  • string

RemotePrivateEndpointConnectionWrapper

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

Name Type Description
id
  • string

Identyfikator zasobu połączenia prywatnego punktu końcowego

name
  • string

Nazwa połączenia prywatnego punktu końcowego

properties.groupIds
  • string[]

Wszystkie identyfikatory grupy.

properties.privateEndpoint

Zasób prywatnego punktu końcowego.

properties.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

Nazwa jednostki SKU.

Name Type Description
Basic
  • string

Podstawowa jednostka SKU usługi Api Management.

Consumption
  • string

Jednostka SKU użycia usługi Api Management.

Developer
  • string

Jednostka SKU dewelopera usługi Api Management.

Isolated
  • string

Izolowana jednostka SKU usługi Api Management.

Premium
  • string

Premium jednostkę SKU usługi Api Management.

Standard
  • string

Standardowa jednostka SKU usługi Api Management.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Name Type Description
createdAt
  • string

Sygnatura czasowa tworzenia zasobów (UTC).

createdBy
  • string

Tożsamość, która utworzyła zasób.

createdByType

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

lastModifiedAt
  • string

Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)

lastModifiedBy
  • string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

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

UserIdentityProperties

Name Type Description
clientId
  • string

Identyfikator klienta tożsamości przypisanej przez użytkownika.

principalId
  • string

Identyfikator podmiotu zabezpieczeń tożsamości przypisanej przez użytkownika.

VirtualNetworkConfiguration

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

Name Type Description
subnetResourceId
  • string

Pełny identyfikator zasobu podsieci w sieci wirtualnej w celu wdrożenia usługi API Management w programie.

subnetname
  • string

Nazwa podsieci.

vnetid
  • string

Identyfikator sieci wirtualnej. Jest to zazwyczaj identyfikator GUID. Domyślnie oczekiwano identyfikatora GUID o wartości null.

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ą żadnego Virtual Network, zewnętrzne oznacza, że wdrożenie API Management jest skonfigurowane wewnątrz Virtual Network mającego internetowy punkt końcowy, a wewnętrzny oznacza, że API Management wdrożenie jest konfigurowane w Virtual Network tylko w punkcie końcowym dostępnym w intranecie.

Name Type Description
External
  • string

Usługa jest częścią Virtual Network i jest dostępna z Internetu.

Internal
  • string

Usługa jest częścią Virtual Network i jest dostępna tylko z poziomu sieci wirtualnej.

None
  • string

Usługa nie jest częścią żadnego Virtual Network.