Microsoft.ApiManagement service/apis 2019-01-01
- najnowsze
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Definicja zasobu Bicep
Typ zasobu usługi/interfejsu API można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania 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/apis, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.ApiManagement/service/apis@2019-01-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
apiRevision: 'string'
apiRevisionDescription: 'string'
apiType: 'string'
apiVersion: 'string'
apiVersionDescription: 'string'
apiVersionSet: {
description: 'string'
id: 'string'
name: 'string'
versionHeaderName: 'string'
versioningScheme: 'string'
versionQueryName: 'string'
}
apiVersionSetId: 'string'
authenticationSettings: {
oAuth2: {
authorizationServerId: 'string'
scope: 'string'
}
openid: {
bearerTokenSendingMethods: [
'string'
]
openidProviderId: 'string'
}
}
description: 'string'
displayName: 'string'
format: 'string'
isCurrent: bool
path: 'string'
protocols: [
'string'
]
serviceUrl: 'string'
sourceApiId: 'string'
subscriptionKeyParameterNames: {
header: 'string'
query: 'string'
}
subscriptionRequired: bool
type: 'string'
value: 'string'
wsdlSelector: {
wsdlEndpointName: 'string'
wsdlServiceName: 'string'
}
}
}
Wartości właściwości
ApiCreateOrUpdatePropertiesOrApiContractProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| apiRevision | Opisuje poprawkę interfejsu API. Jeśli nie podano żadnej wartości, zostanie utworzona domyślna wersja 1 | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 |
| apiRevisionDescription | Opis poprawki interfejsu API. | struna Ograniczenia: Maksymalna długość = |
| apiType | Typ interfejsu API do utworzenia. * http tworzy interfejs API REST protokołu SOAP do interfejsu API REST * soap tworzy interfejs API przekazywania protokołu SOAP. |
"http" "mydło" |
| apiVersion | Wskazuje identyfikator wersji interfejsu API, jeśli interfejs API jest w wersji | struna Ograniczenia: Maksymalna długość = |
| apiVersionDescription | Opis wersji interfejsu API. | struna Ograniczenia: Maksymalna długość = |
| apiVersionSet | Szczegóły zestawu wersji | ApiVersionSetContractDetails |
| apiVersionSetId | Identyfikator zasobu powiązanego elementu ApiVersionSet. | struna |
| authenticationSettings | Kolekcja ustawień uwierzytelniania uwzględnionych w tym interfejsie API. | AuthenticationSettingsContract |
| opis | Opis interfejsu API. Może zawierać tagi formatowania HTML. | struna |
| displayName | Nazwa interfejsu API. Musi mieć długość od 1 do 300 znaków. | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 |
| format | Format zawartości, w której jest importowany interfejs API. | "openapi" "openapi+json" "openapi+json-link" "openapi-link" "swagger-json" "swagger-link-json" "wadl-link-json" "wadl-xml" "wsdl" "wsdl-link" |
| isCurrent | Wskazuje, czy poprawka interfejsu API jest bieżącą poprawką interfejsu API. | Bool |
| ścieżka | Względny adres URL jednoznacznie identyfikujący ten interfejs API i wszystkie jego ścieżki zasobów w wystąpieniu usługi API Management. Jest on dołączany do podstawowego adresu URL punktu końcowego interfejsu API określonego podczas tworzenia wystąpienia usługi w celu utworzenia publicznego adresu URL tego interfejsu API. | struna Ograniczenia: Maksymalna długość = (wymagana) |
| Protokołów | Opisuje, które protokoły mogą być wywoływane operacje w tym interfejsie API. | Tablica ciągów zawierająca dowolną z: "http" "https" |
| serviceUrl | Bezwzględny adres URL usługi zaplecza implementowania tego interfejsu API. Długość nie może przekraczać 2000 znaków. | struna Ograniczenia: Maksymalna długość = |
| sourceApiId | Identyfikator interfejsu API źródłowego interfejsu API. | struna |
| subscriptionKeyParameterNames | Protokoły, za pośrednictwem których udostępniono interfejs API. | SubscriptionKeyParameterNamesContract |
| subscriptionRequired | Określa, czy do uzyskiwania dostępu do interfejsu API jest wymagana subskrypcja interfejsu API lub produktu. | Bool |
| typ | Typ interfejsu API. | "http" "mydło" |
| wartość | Wartość zawartości podczas importowania interfejsu API. | struna |
| wsdlSelector | Kryteria ograniczania importu WSDL do podzestawu dokumentu. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiCreateOrUpdatePropertiesWsdlSelector
| Nazwa | Opis | Wartość |
|---|---|---|
| wsdlEndpointName | Nazwa punktu końcowego (portu) do zaimportowania z WSDL | struna |
| wsdlServiceName | Nazwa usługi do zaimportowania z WSDL | struna |
ApiVersionSetContractDetails
| Nazwa | Opis | Wartość |
|---|---|---|
| opis | Opis zestawu wersji interfejsu API. | struna |
| id | Identyfikator istniejącego zestawu wersji interfejsu API. Pomiń tę wartość, aby utworzyć nowy zestaw wersji. | struna |
| nazwa | Wyświetlana nazwa zestawu wersji interfejsu API. | struna |
| versionHeaderName | Nazwa parametru nagłówka HTTP wskazująca wersję interfejsu API, jeśli parametr versioningScheme jest ustawiony na header. |
struna |
| versioningScheme | Wartość określająca, gdzie identyfikator wersji interfejsu API będzie znajdować się w żądaniu HTTP. | "Nagłówek" "Zapytanie" "Segment" |
| versionQueryName | Nazwa parametru zapytania, który wskazuje wersję interfejsu API, jeśli ustawienie versioningScheme ma wartość query. |
struna |
AuthenticationSettingsContract
| Nazwa | Opis | Wartość |
|---|---|---|
| oAuth2 | Ustawienia uwierzytelniania OAuth2 | OAuth2AuthenticationSettingsContract |
| openid | Ustawienia uwierzytelniania OpenID Connect | OpenIdAuthenticationSettingsContract |
Microsoft.ApiManagement/service/apis
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 Wzorzec = ^[^*#&+:<>?]+$ (wymagane) |
| 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 | Jednostka interfejsu API tworzy właściwości aktualizacji. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
OAuth2AuthenticationSettingsContract
| Nazwa | Opis | Wartość |
|---|---|---|
| authorizationServerId | Identyfikator serwera autoryzacji OAuth. | struna |
| zakres | zakres operacji. | struna |
OpenIdAuthenticationSettingsContract
| Nazwa | Opis | Wartość |
|---|---|---|
| bearerTokenSendingMethods | Jak wysłać token do serwera. | Tablica ciągów zawierająca dowolną z: "authorizationHeader" "zapytanie" |
| openidProviderId | Identyfikator serwera autoryzacji OAuth. | struna |
SubscriptionKeyParameterNamesContract
| Nazwa | Opis | Wartość |
|---|---|---|
| nagłówek | Nazwa nagłówka klucza subskrypcji. | struna |
| zapytanie | Nazwa parametru ciągu zapytania klucza subskrypcji. | struna |
Definicja zasobu szablonu usługi ARM
Typ zasobu usługi/interfejsu API można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania 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/apis, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.ApiManagement/service/apis",
"apiVersion": "2019-01-01",
"name": "string",
"properties": {
"apiRevision": "string",
"apiRevisionDescription": "string",
"apiType": "string",
"apiVersion": "string",
"apiVersionDescription": "string",
"apiVersionSet": {
"description": "string",
"id": "string",
"name": "string",
"versionHeaderName": "string",
"versioningScheme": "string",
"versionQueryName": "string"
},
"apiVersionSetId": "string",
"authenticationSettings": {
"oAuth2": {
"authorizationServerId": "string",
"scope": "string"
},
"openid": {
"bearerTokenSendingMethods": [ "string" ],
"openidProviderId": "string"
}
},
"description": "string",
"displayName": "string",
"format": "string",
"isCurrent": "bool",
"path": "string",
"protocols": [ "string" ],
"serviceUrl": "string",
"sourceApiId": "string",
"subscriptionKeyParameterNames": {
"header": "string",
"query": "string"
},
"subscriptionRequired": "bool",
"type": "string",
"value": "string",
"wsdlSelector": {
"wsdlEndpointName": "string",
"wsdlServiceName": "string"
}
}
}
Wartości właściwości
ApiCreateOrUpdatePropertiesOrApiContractProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| apiRevision | Opisuje poprawkę interfejsu API. Jeśli nie podano żadnej wartości, zostanie utworzona domyślna wersja 1 | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 |
| apiRevisionDescription | Opis poprawki interfejsu API. | struna Ograniczenia: Maksymalna długość = |
| apiType | Typ interfejsu API do utworzenia. * http tworzy interfejs API REST protokołu SOAP do interfejsu API REST * soap tworzy interfejs API przekazywania protokołu SOAP. |
"http" "mydło" |
| apiVersion | Wskazuje identyfikator wersji interfejsu API, jeśli interfejs API jest w wersji | struna Ograniczenia: Maksymalna długość = |
| apiVersionDescription | Opis wersji interfejsu API. | struna Ograniczenia: Maksymalna długość = |
| apiVersionSet | Szczegóły zestawu wersji | ApiVersionSetContractDetails |
| apiVersionSetId | Identyfikator zasobu powiązanego elementu ApiVersionSet. | struna |
| authenticationSettings | Kolekcja ustawień uwierzytelniania uwzględnionych w tym interfejsie API. | AuthenticationSettingsContract |
| opis | Opis interfejsu API. Może zawierać tagi formatowania HTML. | struna |
| displayName | Nazwa interfejsu API. Musi mieć długość od 1 do 300 znaków. | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 |
| format | Format zawartości, w której jest importowany interfejs API. | "openapi" "openapi+json" "openapi+json-link" "openapi-link" "swagger-json" "swagger-link-json" "wadl-link-json" "wadl-xml" "wsdl" "wsdl-link" |
| isCurrent | Wskazuje, czy poprawka interfejsu API jest bieżącą poprawką interfejsu API. | Bool |
| ścieżka | Względny adres URL jednoznacznie identyfikujący ten interfejs API i wszystkie jego ścieżki zasobów w wystąpieniu usługi API Management. Jest on dołączany do podstawowego adresu URL punktu końcowego interfejsu API określonego podczas tworzenia wystąpienia usługi w celu utworzenia publicznego adresu URL tego interfejsu API. | struna Ograniczenia: Maksymalna długość = (wymagana) |
| Protokołów | Opisuje, które protokoły mogą być wywoływane operacje w tym interfejsie API. | Tablica ciągów zawierająca dowolną z: "http" "https" |
| serviceUrl | Bezwzględny adres URL usługi zaplecza implementowania tego interfejsu API. Długość nie może przekraczać 2000 znaków. | struna Ograniczenia: Maksymalna długość = |
| sourceApiId | Identyfikator interfejsu API źródłowego interfejsu API. | struna |
| subscriptionKeyParameterNames | Protokoły, za pośrednictwem których udostępniono interfejs API. | SubscriptionKeyParameterNamesContract |
| subscriptionRequired | Określa, czy do uzyskiwania dostępu do interfejsu API jest wymagana subskrypcja interfejsu API lub produktu. | Bool |
| typ | Typ interfejsu API. | "http" "mydło" |
| wartość | Wartość zawartości podczas importowania interfejsu API. | struna |
| wsdlSelector | Kryteria ograniczania importu WSDL do podzestawu dokumentu. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiCreateOrUpdatePropertiesWsdlSelector
| Nazwa | Opis | Wartość |
|---|---|---|
| wsdlEndpointName | Nazwa punktu końcowego (portu) do zaimportowania z WSDL | struna |
| wsdlServiceName | Nazwa usługi do zaimportowania z WSDL | struna |
ApiVersionSetContractDetails
| Nazwa | Opis | Wartość |
|---|---|---|
| opis | Opis zestawu wersji interfejsu API. | struna |
| id | Identyfikator istniejącego zestawu wersji interfejsu API. Pomiń tę wartość, aby utworzyć nowy zestaw wersji. | struna |
| nazwa | Wyświetlana nazwa zestawu wersji interfejsu API. | struna |
| versionHeaderName | Nazwa parametru nagłówka HTTP wskazująca wersję interfejsu API, jeśli parametr versioningScheme jest ustawiony na header. |
struna |
| versioningScheme | Wartość określająca, gdzie identyfikator wersji interfejsu API będzie znajdować się w żądaniu HTTP. | "Nagłówek" "Zapytanie" "Segment" |
| versionQueryName | Nazwa parametru zapytania, który wskazuje wersję interfejsu API, jeśli ustawienie versioningScheme ma wartość query. |
struna |
AuthenticationSettingsContract
| Nazwa | Opis | Wartość |
|---|---|---|
| oAuth2 | Ustawienia uwierzytelniania OAuth2 | OAuth2AuthenticationSettingsContract |
| openid | Ustawienia uwierzytelniania OpenID Connect | OpenIdAuthenticationSettingsContract |
Microsoft.ApiManagement/service/apis
| Nazwa | Opis | Wartość |
|---|---|---|
| apiVersion | Wersja interfejsu API | '2019-01-01' |
| nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 Wzorzec = ^[^*#&+:<>?]+$ (wymagane) |
| Właściwości | Jednostka interfejsu API tworzy właściwości aktualizacji. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
| typ | Typ zasobu | "Microsoft.ApiManagement/service/apis" |
OAuth2AuthenticationSettingsContract
| Nazwa | Opis | Wartość |
|---|---|---|
| authorizationServerId | Identyfikator serwera autoryzacji OAuth. | struna |
| zakres | zakres operacji. | struna |
OpenIdAuthenticationSettingsContract
| Nazwa | Opis | Wartość |
|---|---|---|
| bearerTokenSendingMethods | Jak wysłać token do serwera. | Tablica ciągów zawierająca dowolną z: "authorizationHeader" "zapytanie" |
| openidProviderId | Identyfikator serwera autoryzacji OAuth. | struna |
SubscriptionKeyParameterNamesContract
| Nazwa | Opis | Wartość |
|---|---|---|
| nagłówek | Nazwa nagłówka klucza subskrypcji. | struna |
| zapytanie | Nazwa parametru ciągu zapytania klucza subskrypcji. | struna |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu usługi/interfejsu API 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/apis, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis@2019-01-01"
name = "string"
body = jsonencode({
properties = {
apiRevision = "string"
apiRevisionDescription = "string"
apiType = "string"
apiVersion = "string"
apiVersionDescription = "string"
apiVersionSet = {
description = "string"
id = "string"
name = "string"
versionHeaderName = "string"
versioningScheme = "string"
versionQueryName = "string"
}
apiVersionSetId = "string"
authenticationSettings = {
oAuth2 = {
authorizationServerId = "string"
scope = "string"
}
openid = {
bearerTokenSendingMethods = [
"string"
]
openidProviderId = "string"
}
}
description = "string"
displayName = "string"
format = "string"
isCurrent = bool
path = "string"
protocols = [
"string"
]
serviceUrl = "string"
sourceApiId = "string"
subscriptionKeyParameterNames = {
header = "string"
query = "string"
}
subscriptionRequired = bool
type = "string"
value = "string"
wsdlSelector = {
wsdlEndpointName = "string"
wsdlServiceName = "string"
}
}
})
}
Wartości właściwości
ApiCreateOrUpdatePropertiesOrApiContractProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| apiRevision | Opisuje poprawkę interfejsu API. Jeśli nie podano żadnej wartości, zostanie utworzona domyślna wersja 1 | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 |
| apiRevisionDescription | Opis poprawki interfejsu API. | struna Ograniczenia: Maksymalna długość = |
| apiType | Typ interfejsu API do utworzenia. * http tworzy interfejs API REST protokołu SOAP do interfejsu API REST * soap tworzy interfejs API przekazywania protokołu SOAP. |
"http" "mydło" |
| apiVersion | Wskazuje identyfikator wersji interfejsu API, jeśli interfejs API jest w wersji | struna Ograniczenia: Maksymalna długość = |
| apiVersionDescription | Opis wersji interfejsu API. | struna Ograniczenia: Maksymalna długość = |
| apiVersionSet | Szczegóły zestawu wersji | ApiVersionSetContractDetails |
| apiVersionSetId | Identyfikator zasobu powiązanego elementu ApiVersionSet. | struna |
| authenticationSettings | Kolekcja ustawień uwierzytelniania uwzględnionych w tym interfejsie API. | AuthenticationSettingsContract |
| opis | Opis interfejsu API. Może zawierać tagi formatowania HTML. | struna |
| displayName | Nazwa interfejsu API. Musi mieć długość od 1 do 300 znaków. | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 |
| format | Format zawartości, w której jest importowany interfejs API. | "openapi" "openapi+json" "openapi+json-link" "openapi-link" "swagger-json" "swagger-link-json" "wadl-link-json" "wadl-xml" "wsdl" "wsdl-link" |
| isCurrent | Wskazuje, czy poprawka interfejsu API jest bieżącą poprawką interfejsu API. | Bool |
| ścieżka | Względny adres URL jednoznacznie identyfikujący ten interfejs API i wszystkie jego ścieżki zasobów w wystąpieniu usługi API Management. Jest on dołączany do podstawowego adresu URL punktu końcowego interfejsu API określonego podczas tworzenia wystąpienia usługi w celu utworzenia publicznego adresu URL tego interfejsu API. | struna Ograniczenia: Maksymalna długość = (wymagana) |
| Protokołów | Opisuje, które protokoły mogą być wywoływane operacje w tym interfejsie API. | Tablica ciągów zawierająca dowolną z: "http" "https" |
| serviceUrl | Bezwzględny adres URL usługi zaplecza implementowania tego interfejsu API. Długość nie może przekraczać 2000 znaków. | struna Ograniczenia: Maksymalna długość = |
| sourceApiId | Identyfikator interfejsu API źródłowego interfejsu API. | struna |
| subscriptionKeyParameterNames | Protokoły, za pośrednictwem których udostępniono interfejs API. | SubscriptionKeyParameterNamesContract |
| subscriptionRequired | Określa, czy do uzyskiwania dostępu do interfejsu API jest wymagana subskrypcja interfejsu API lub produktu. | Bool |
| typ | Typ interfejsu API. | "http" "mydło" |
| wartość | Wartość zawartości podczas importowania interfejsu API. | struna |
| wsdlSelector | Kryteria ograniczania importu WSDL do podzestawu dokumentu. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiCreateOrUpdatePropertiesWsdlSelector
| Nazwa | Opis | Wartość |
|---|---|---|
| wsdlEndpointName | Nazwa punktu końcowego (portu) do zaimportowania z WSDL | struna |
| wsdlServiceName | Nazwa usługi do zaimportowania z WSDL | struna |
ApiVersionSetContractDetails
| Nazwa | Opis | Wartość |
|---|---|---|
| opis | Opis zestawu wersji interfejsu API. | struna |
| id | Identyfikator istniejącego zestawu wersji interfejsu API. Pomiń tę wartość, aby utworzyć nowy zestaw wersji. | struna |
| nazwa | Wyświetlana nazwa zestawu wersji interfejsu API. | struna |
| versionHeaderName | Nazwa parametru nagłówka HTTP wskazująca wersję interfejsu API, jeśli parametr versioningScheme jest ustawiony na header. |
struna |
| versioningScheme | Wartość określająca, gdzie identyfikator wersji interfejsu API będzie znajdować się w żądaniu HTTP. | "Nagłówek" "Zapytanie" "Segment" |
| versionQueryName | Nazwa parametru zapytania, który wskazuje wersję interfejsu API, jeśli ustawienie versioningScheme ma wartość query. |
struna |
AuthenticationSettingsContract
| Nazwa | Opis | Wartość |
|---|---|---|
| oAuth2 | Ustawienia uwierzytelniania OAuth2 | OAuth2AuthenticationSettingsContract |
| openid | Ustawienia uwierzytelniania OpenID Connect | OpenIdAuthenticationSettingsContract |
Microsoft.ApiManagement/service/apis
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 Wzorzec = ^[^*#&+:<>?]+$ (wymagane) |
| parent_id | Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. | Identyfikator zasobu typu: usługi |
| Właściwości | Jednostka interfejsu API tworzy właściwości aktualizacji. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
| typ | Typ zasobu | "Microsoft.ApiManagement/service/apis@2019-01-01" |
OAuth2AuthenticationSettingsContract
| Nazwa | Opis | Wartość |
|---|---|---|
| authorizationServerId | Identyfikator serwera autoryzacji OAuth. | struna |
| zakres | zakres operacji. | struna |
OpenIdAuthenticationSettingsContract
| Nazwa | Opis | Wartość |
|---|---|---|
| bearerTokenSendingMethods | Jak wysłać token do serwera. | Tablica ciągów zawierająca dowolną z: "authorizationHeader" "zapytanie" |
| openidProviderId | Identyfikator serwera autoryzacji OAuth. | struna |
SubscriptionKeyParameterNamesContract
| Nazwa | Opis | Wartość |
|---|---|---|
| nagłówek | Nazwa nagłówka klucza subskrypcji. | struna |
| zapytanie | Nazwa parametru ciągu zapytania klucza subskrypcji. | struna |