Udostępnij za pośrednictwem

Microsoft.ApiManagement service/backends 2021-04-01-preview

  • Artykuł

Definicja zasobu Bicep

Typ zasobu usługi/zaplecza można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/backends, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.ApiManagement/service/backends@2021-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    credentials: {
      authorization: {
        parameter: 'string'
        scheme: 'string'
      }
      certificate: [
        'string'
      ]
      certificateIds: [
        'string'
      ]
      header: {
        {customized property}: [
          'string'
        ]
      }
      query: {
        {customized property}: [
          'string'
        ]
      }
    }
    description: 'string'
    properties: {
      serviceFabricCluster: {
        clientCertificateId: 'string'
        clientCertificatethumbprint: 'string'
        managementEndpoints: [
          'string'
        ]
        maxPartitionResolutionRetries: int
        serverCertificateThumbprints: [
          'string'
        ]
        serverX509Names: [
          {
            issuerCertificateThumbprint: 'string'
            name: 'string'
          }
        ]
      }
    }
    protocol: 'string'
    proxy: {
      password: 'string'
      url: 'string'
      username: 'string'
    }
    resourceId: 'string'
    title: 'string'
    tls: {
      validateCertificateChain: bool
      validateCertificateName: bool
    }
    url: 'string'
  }
}

Wartości właściwości

BackendAuthorizationHeaderCredentials

Nazwa Opis Wartość
parametr Wartość parametru uwierzytelniania. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1 (wymagana)
plan Nazwa schematu uwierzytelniania. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1 (wymagana)

BackendContractProperties

Nazwa Opis Wartość
Poświadczenia Właściwości kontraktu poświadczeń zaplecza BackendCredentialsContract
opis Opis zaplecza. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1
Właściwości Kontrakt właściwości zaplecza BackendProperties
protokół Protokół komunikacyjny zaplecza. "http"
"soap" (wymagane)
proxy Właściwości kontraktu serwera proxy zaplecza BackendProxyContract
resourceId Identyfikator URI zarządzania zasobu w systemie zewnętrznym. Ten adres URL może być identyfikatorem zasobu arm usługi Logic Apps, aplikacji funkcji lub aplikacji interfejsu API. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1
tytuł Tytuł zaplecza. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1
tls Właściwości protokołu TLS zaplecza BackendTlsProperties
adres URL Adres URL środowiska uruchomieniowego zaplecza. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1 (wymagana)

BackendCredentialsContract

Nazwa Opis Wartość
autoryzacja Uwierzytelnianie nagłówka autoryzacji BackendAuthorizationHeaderCredentials
certyfikat Lista odcisków palca certyfikatu klienta. Jeśli podano identyfikatory certyfikatów, zostaną zignorowane. string[]
identyfikatory certyfikatów Lista identyfikatorów certyfikatów klienta. string[]
nagłówek Opis parametru nagłówka. BackendCredentialsContractHeader
zapytanie Opis parametru zapytania. BackendCredentialsContractQuery

BackendCredentialsContractHeader

Nazwa Opis Wartość

BackendCredentialsContractQuery

Nazwa Opis Wartość

Właściwości zaplecza

Nazwa Opis Wartość
serviceFabricCluster Właściwości klastra usługi Service Fabric zaplecza BackendServiceFabricClusterProperties

BackendProxyContract

Nazwa Opis Wartość
hasło Hasło do nawiązania połączenia z serwerem WebProxy struna
adres URL Właściwość AbsoluteUri serwera WebProxy, która zawiera cały identyfikator URI przechowywany w wystąpieniu identyfikatora Uri, w tym wszystkie fragmenty i ciągi zapytania. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1 (wymagana)
nazwa użytkownika Nazwa użytkownika do nawiązania połączenia z serwerem WebProxy struna

BackendServiceFabricClusterProperties

Nazwa Opis Wartość
clientCertificateId Identyfikator certyfikatu klienta dla punktu końcowego zarządzania. struna
clientCertificatethumbprint Odcisk palca certyfikatu klienta dla punktu końcowego zarządzania. Jeśli podano identyfikatory certyfikatów, zostaną zignorowane struna
managementEndpoints Punkt końcowy zarządzania klastrem. string[] (wymagane)
maxPartitionResolutionRetries Maksymalna liczba ponownych prób podczas próby rozwiązania partycji. Int
serverCertificateThumbprints Odciski palca usługi zarządzania klastrem certyfikatów używane do komunikacji tls string[]
serverX509Names Kolekcja nazw certyfikatów X509 serwera X509CertificateName[]

BackendTlsProperties

Nazwa Opis Wartość
validateCertificateChain Flaga wskazująca, czy podczas korzystania z certyfikatów z podpisem własnym dla tego hosta zaplecza należy przeprowadzić walidację łańcucha certyfikatów SSL. Bool
validateCertificateName Flaga wskazująca, czy podczas korzystania z certyfikatów z podpisem własnym dla tego hosta zaplecza należy przeprowadzić walidację nazwy certyfikatu SSL. Bool

Microsoft.ApiManagement/service/backends

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1 (wymagana)
rodzic W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.		 Nazwa symboliczna zasobu typu: usługi
Właściwości Właściwości kontraktu jednostki zaplecza. BackendContractProperties

X509CertificateName

Nazwa Opis Wartość
issuerCertificateThumbprint Odcisk palca wystawcy certyfikatu. struna
nazwa Nazwa pospolita certyfikatu. struna

Definicja zasobu szablonu usługi ARM

Typ zasobu usługi/zaplecza można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/backends, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.ApiManagement/service/backends",
  "apiVersion": "2021-04-01-preview",
  "name": "string",
  "properties": {
    "credentials": {
      "authorization": {
        "parameter": "string",
        "scheme": "string"
      },
      "certificate": [ "string" ],
      "certificateIds": [ "string" ],
      "header": {
        "{customized property}": [ "string" ]
      },
      "query": {
        "{customized property}": [ "string" ]
      }
    },
    "description": "string",
    "properties": {
      "serviceFabricCluster": {
        "clientCertificateId": "string",
        "clientCertificatethumbprint": "string",
        "managementEndpoints": [ "string" ],
        "maxPartitionResolutionRetries": "int",
        "serverCertificateThumbprints": [ "string" ],
        "serverX509Names": [
          {
            "issuerCertificateThumbprint": "string",
            "name": "string"
          }
        ]
      }
    },
    "protocol": "string",
    "proxy": {
      "password": "string",
      "url": "string",
      "username": "string"
    },
    "resourceId": "string",
    "title": "string",
    "tls": {
      "validateCertificateChain": "bool",
      "validateCertificateName": "bool"
    },
    "url": "string"
  }
}

Wartości właściwości

BackendAuthorizationHeaderCredentials

Nazwa Opis Wartość
parametr Wartość parametru uwierzytelniania. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1 (wymagana)
plan Nazwa schematu uwierzytelniania. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1 (wymagana)

BackendContractProperties

Nazwa Opis Wartość
Poświadczenia Właściwości kontraktu poświadczeń zaplecza BackendCredentialsContract
opis Opis zaplecza. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1
Właściwości Kontrakt właściwości zaplecza BackendProperties
protokół Protokół komunikacyjny zaplecza. "http"
"soap" (wymagane)
proxy Właściwości kontraktu serwera proxy zaplecza BackendProxyContract
resourceId Identyfikator URI zarządzania zasobu w systemie zewnętrznym. Ten adres URL może być identyfikatorem zasobu arm usługi Logic Apps, aplikacji funkcji lub aplikacji interfejsu API. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1
tytuł Tytuł zaplecza. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1
tls Właściwości protokołu TLS zaplecza BackendTlsProperties
adres URL Adres URL środowiska uruchomieniowego zaplecza. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1 (wymagana)

BackendCredentialsContract

Nazwa Opis Wartość
autoryzacja Uwierzytelnianie nagłówka autoryzacji BackendAuthorizationHeaderCredentials
certyfikat Lista odcisków palca certyfikatu klienta. Jeśli podano identyfikatory certyfikatów, zostaną zignorowane. string[]
identyfikatory certyfikatów Lista identyfikatorów certyfikatów klienta. string[]
nagłówek Opis parametru nagłówka. BackendCredentialsContractHeader
zapytanie Opis parametru zapytania. BackendCredentialsContractQuery

BackendCredentialsContractHeader

Nazwa Opis Wartość

BackendCredentialsContractQuery

Nazwa Opis Wartość

Właściwości zaplecza

Nazwa Opis Wartość
serviceFabricCluster Właściwości klastra usługi Service Fabric zaplecza BackendServiceFabricClusterProperties

BackendProxyContract

Nazwa Opis Wartość
hasło Hasło do nawiązania połączenia z serwerem WebProxy struna
adres URL Właściwość AbsoluteUri serwera WebProxy, która zawiera cały identyfikator URI przechowywany w wystąpieniu identyfikatora Uri, w tym wszystkie fragmenty i ciągi zapytania. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1 (wymagana)
nazwa użytkownika Nazwa użytkownika do nawiązania połączenia z serwerem WebProxy struna

BackendServiceFabricClusterProperties

Nazwa Opis Wartość
clientCertificateId Identyfikator certyfikatu klienta dla punktu końcowego zarządzania. struna
clientCertificatethumbprint Odcisk palca certyfikatu klienta dla punktu końcowego zarządzania. Jeśli podano identyfikatory certyfikatów, zostaną zignorowane struna
managementEndpoints Punkt końcowy zarządzania klastrem. string[] (wymagane)
maxPartitionResolutionRetries Maksymalna liczba ponownych prób podczas próby rozwiązania partycji. Int
serverCertificateThumbprints Odciski palca usługi zarządzania klastrem certyfikatów używane do komunikacji tls string[]
serverX509Names Kolekcja nazw certyfikatów X509 serwera X509CertificateName[]

BackendTlsProperties

Nazwa Opis Wartość
validateCertificateChain Flaga wskazująca, czy podczas korzystania z certyfikatów z podpisem własnym dla tego hosta zaplecza należy przeprowadzić walidację łańcucha certyfikatów SSL. Bool
validateCertificateName Flaga wskazująca, czy podczas korzystania z certyfikatów z podpisem własnym dla tego hosta zaplecza należy przeprowadzić walidację nazwy certyfikatu SSL. Bool

Microsoft.ApiManagement/service/backends

Nazwa Opis Wartość
apiVersion Wersja interfejsu API "2021-04-01-preview"
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1 (wymagana)
Właściwości Właściwości kontraktu jednostki zaplecza. BackendContractProperties
typ Typ zasobu "Microsoft.ApiManagement/service/backends"

X509CertificateName

Nazwa Opis Wartość
issuerCertificateThumbprint Odcisk palca wystawcy certyfikatu. struna
nazwa Nazwa pospolita certyfikatu. struna

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu usługi/zaplecza można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/backends, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/backends@2021-04-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      credentials = {
        authorization = {
          parameter = "string"
          scheme = "string"
        }
        certificate = [
          "string"
        ]
        certificateIds = [
          "string"
        ]
        header = {
          {customized property} = [
            "string"
          ]
        }
        query = {
          {customized property} = [
            "string"
          ]
        }
      }
      description = "string"
      properties = {
        serviceFabricCluster = {
          clientCertificateId = "string"
          clientCertificatethumbprint = "string"
          managementEndpoints = [
            "string"
          ]
          maxPartitionResolutionRetries = int
          serverCertificateThumbprints = [
            "string"
          ]
          serverX509Names = [
            {
              issuerCertificateThumbprint = "string"
              name = "string"
            }
          ]
        }
      }
      protocol = "string"
      proxy = {
        password = "string"
        url = "string"
        username = "string"
      }
      resourceId = "string"
      title = "string"
      tls = {
        validateCertificateChain = bool
        validateCertificateName = bool
      }
      url = "string"
    }
  })
}

Wartości właściwości

BackendAuthorizationHeaderCredentials

Nazwa Opis Wartość
parametr Wartość parametru uwierzytelniania. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1 (wymagana)
plan Nazwa schematu uwierzytelniania. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1 (wymagana)

BackendContractProperties

Nazwa Opis Wartość
Poświadczenia Właściwości kontraktu poświadczeń zaplecza BackendCredentialsContract
opis Opis zaplecza. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1
Właściwości Kontrakt właściwości zaplecza BackendProperties
protokół Protokół komunikacyjny zaplecza. "http"
"soap" (wymagane)
proxy Właściwości kontraktu serwera proxy zaplecza BackendProxyContract
resourceId Identyfikator URI zarządzania zasobu w systemie zewnętrznym. Ten adres URL może być identyfikatorem zasobu arm usługi Logic Apps, aplikacji funkcji lub aplikacji interfejsu API. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1
tytuł Tytuł zaplecza. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1
tls Właściwości protokołu TLS zaplecza BackendTlsProperties
adres URL Adres URL środowiska uruchomieniowego zaplecza. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1 (wymagana)

BackendCredentialsContract

Nazwa Opis Wartość
autoryzacja Uwierzytelnianie nagłówka autoryzacji BackendAuthorizationHeaderCredentials
certyfikat Lista odcisków palca certyfikatu klienta. Jeśli podano identyfikatory certyfikatów, zostaną zignorowane. string[]
identyfikatory certyfikatów Lista identyfikatorów certyfikatów klienta. string[]
nagłówek Opis parametru nagłówka. BackendCredentialsContractHeader
zapytanie Opis parametru zapytania. BackendCredentialsContractQuery

BackendCredentialsContractHeader

Nazwa Opis Wartość

BackendCredentialsContractQuery

Nazwa Opis Wartość

Właściwości zaplecza

Nazwa Opis Wartość
serviceFabricCluster Właściwości klastra usługi Service Fabric zaplecza BackendServiceFabricClusterProperties

BackendProxyContract

Nazwa Opis Wartość
hasło Hasło do nawiązania połączenia z serwerem WebProxy struna
adres URL Właściwość AbsoluteUri serwera WebProxy, która zawiera cały identyfikator URI przechowywany w wystąpieniu identyfikatora Uri, w tym wszystkie fragmenty i ciągi zapytania. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1 (wymagana)
nazwa użytkownika Nazwa użytkownika do nawiązania połączenia z serwerem WebProxy struna

BackendServiceFabricClusterProperties

Nazwa Opis Wartość
clientCertificateId Identyfikator certyfikatu klienta dla punktu końcowego zarządzania. struna
clientCertificatethumbprint Odcisk palca certyfikatu klienta dla punktu końcowego zarządzania. Jeśli podano identyfikatory certyfikatów, zostaną zignorowane struna
managementEndpoints Punkt końcowy zarządzania klastrem. string[] (wymagane)
maxPartitionResolutionRetries Maksymalna liczba ponownych prób podczas próby rozwiązania partycji. Int
serverCertificateThumbprints Odciski palca usługi zarządzania klastrem certyfikatów używane do komunikacji tls string[]
serverX509Names Kolekcja nazw certyfikatów X509 serwera X509CertificateName[]

BackendTlsProperties

Nazwa Opis Wartość
validateCertificateChain Flaga wskazująca, czy podczas korzystania z certyfikatów z podpisem własnym dla tego hosta zaplecza należy przeprowadzić walidację łańcucha certyfikatów SSL. Bool
validateCertificateName Flaga wskazująca, czy podczas korzystania z certyfikatów z podpisem własnym dla tego hosta zaplecza należy przeprowadzić walidację nazwy certyfikatu SSL. Bool

Microsoft.ApiManagement/service/backends

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1 (wymagana)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: usługi
Właściwości Właściwości kontraktu jednostki zaplecza. BackendContractProperties
typ Typ zasobu "Microsoft.ApiManagement/service/backends@2021-04-01-preview"

X509CertificateName

Nazwa Opis Wartość
issuerCertificateThumbprint Odcisk palca wystawcy certyfikatu. struna
nazwa Nazwa pospolita certyfikatu. struna