Microsoft.Web connections 2015-08-01-preview
Definicja zasobu Bicep
Typ zasobu połączeń 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.Web/connections, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.Web/connections@2015-08-01-preview' = {
kind: 'string'
location: 'string'
name: 'string'
properties: {
api: {
id: 'string'
kind: 'string'
location: 'string'
name: 'string'
properties: {
entity: {
id: 'string'
location: 'string'
name: 'string'
plan: {
name: 'string'
product: 'string'
promotionCode: 'string'
publisher: 'string'
version: 'string'
}
properties: {
id: 'string'
kind: 'string'
location: 'string'
name: 'string'
properties: {
apiDefinitionUrl: 'string'
backendService: {
id: 'string'
kind: 'string'
location: 'string'
name: 'string'
properties: {
hostingEnvironmentServiceUrls: [
{
hostId: 'string'
hostingEnvironmentId: 'string'
serviceUrl: 'string'
useInternalRouting: bool
}
]
serviceUrl: 'string'
}
tags: {
{customized property}: 'string'
}
type: 'string'
}
capabilities: [
'string'
]
changedTime: 'string'
connectionParameters: {
{customized property}: {
defaultValue: any(Azure.Bicep.Types.Concrete.AnyType)
oAuthSettings: {
clientId: 'string'
clientSecret: 'string'
customParameters: {
{customized property}: {
options: any(Azure.Bicep.Types.Concrete.AnyType)
uiDefinition: any(Azure.Bicep.Types.Concrete.AnyType)
value: 'string'
}
}
identityProvider: 'string'
properties: any(Azure.Bicep.Types.Concrete.AnyType)
redirectUrl: 'string'
scopes: [
'string'
]
}
type: 'string'
uiDefinition: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
createdTime: 'string'
generalInformation: {
id: 'string'
kind: 'string'
location: 'string'
name: 'string'
properties: {
connectionDisplayName: 'string'
connectionPortalUrl: any(Azure.Bicep.Types.Concrete.AnyType)
description: 'string'
displayName: 'string'
iconUrl: 'string'
termsOfUseUrl: 'string'
}
tags: {
{customized property}: 'string'
}
type: 'string'
}
metadata: any(Azure.Bicep.Types.Concrete.AnyType)
name: 'string'
path: 'string'
policies: {
id: 'string'
kind: 'string'
location: 'string'
name: 'string'
properties: {
content: 'string'
}
tags: {
{customized property}: 'string'
}
type: 'string'
}
protocols: [
'string'
]
runtimeUrls: [
'string'
]
}
tags: {
{customized property}: 'string'
}
type: 'string'
}
sku: {
capacity: int
family: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
type: 'string'
}
id: 'string'
}
tags: {
{customized property}: 'string'
}
type: 'string'
}
changedTime: 'string'
createdTime: 'string'
customParameterValues: {
{customized property}: {
id: 'string'
kind: 'string'
location: 'string'
name: 'string'
properties: {
customParameters: {
{customized property}: {
id: 'string'
kind: 'string'
location: 'string'
name: 'string'
properties: {
option: 'string'
}
tags: {
{customized property}: 'string'
}
type: 'string'
}
}
}
tags: {
{customized property}: 'string'
}
type: 'string'
}
}
displayName: 'string'
firstExpirationTime: 'string'
keywords: [
'string'
]
metadata: any(Azure.Bicep.Types.Concrete.AnyType)
name: 'string'
nonSecretParameterValues: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
parameterValues: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
statuses: [
{
id: 'string'
kind: 'string'
location: 'string'
name: 'string'
properties: {
error: {
id: 'string'
kind: 'string'
location: 'string'
name: 'string'
properties: {
code: 'string'
message: 'string'
}
tags: {
{customized property}: 'string'
}
type: 'string'
}
status: 'string'
target: 'string'
}
tags: {
{customized property}: 'string'
}
type: 'string'
}
]
tenantId: 'string'
}
tags: {
{customized property}: 'string'
}
}
Wartości właściwości
ApiEntity
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | ApiEntityProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
ApiEntityProperties
Nazwa | Opis | Wartość |
---|---|---|
apiDefinitionUrl | Adres URL definicji interfejsu API — adres URL, z którego można pobrać program Swagger | struna |
backendService | Definicja usługi zaplecza | BackendServiceDefinition |
Możliwości | Możliwości | string[] |
changedTime | Sygnatura czasowa ostatniej zmiany połączenia. | struna |
connectionParameters | Parametry połączenia | ApiEntityPropertiesConnectionParameters |
createdTime | Sygnatura czasowa tworzenia połączenia | struna |
generalInformation | ścieżka adresu URL tego interfejsu API w przypadku uwidocznienia za pośrednictwem usługi APIM | GeneralApiInformation |
metadane | Dowolny obiekt formularza dla obiektu wywołującego dane chce przechowywać | jakikolwiek |
nazwa | Nazwa interfejsu API ścieżka adresu URL tego interfejsu API w przypadku uwidocznienia za pośrednictwem usługi APIM |
struna |
ścieżka | ścieżka adresu URL tego interfejsu API w przypadku uwidocznienia za pośrednictwem usługi APIM | struna |
manifest | Zasady interfejsu API | ApiPolicies |
Protokołów | Protokoły obsługiwane przez fronton — http/https | string[] |
runtimeUrls | Właściwość tylko do odczytu zwracająca punkty końcowe środowiska uruchomieniowego, w których można wywołać interfejs API | string[] |
ApiEntityPropertiesConnectionParameters
Nazwa | Opis | Wartość |
---|
ApiOAuthSettings
Nazwa | Opis | Wartość |
---|---|---|
clientId | Identyfikator klienta dostawcy zasobów | struna |
clientSecret | Klucz tajny klienta wymagany do uwierzytelniania OAuth | struna |
customParameters | Klucz parametrów OAuth to nazwa parametru | ApiOAuthSettingsCustomParameters |
identityProvider | Dostawca tożsamości | struna |
Właściwości | Właściwości tylko do odczytu dla tego ustawienia oauth. | jakikolwiek |
redirectUrl | Adres URL | struna |
Zakresów | Zakresy OAuth | string[] |
ApiOAuthSettingsCustomParameters
Nazwa | Opis | Wartość |
---|
ApiOAuthSettingsParameter
Nazwa | Opis | Wartość |
---|---|---|
Opcje | Tylko do odczytu: opcje dostępne dla tego parametru | jakikolwiek |
uiDefinition | Definicje interfejsu użytkownika na kulturę, ponieważ obiekt wywołujący może określić kulturę | jakikolwiek |
wartość | Wartość | struna |
ApiPolicies
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | ApiPoliciesProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
ApiPoliciesProperties
Nazwa | Opis | Wartość |
---|---|---|
zawartość | Zawartość zasad xml | struna |
ArmPlan
Nazwa | Opis | Wartość |
---|---|---|
nazwa | Nazwa | struna |
produkt | Produkt | struna |
kod podwyższania poziomu | Kod podwyższania poziomu | struna |
wydawca | Wydawca | struna |
Wersja | Wersja produktu | struna |
BackendServiceDefinition
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | BackendServiceDefinitionProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
BackendServiceDefinitionProperties
Nazwa | Opis | Wartość |
---|---|---|
hostingEnvironmentServiceUrls | Adresy URL usług na środowisko hostingu | HostingEnvironmentServiceDescriptions[] |
serviceUrl | Adres URL, z którego zostanie pobrany ładunek struktury Swagger | struna |
ConnectionError
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | ConnectionErrorProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
ConnectionErrorProperties
Nazwa | Opis | Wartość |
---|---|---|
kod | kod stanu | struna |
Komunikat | Opis stanu | struna |
Parametr połączenia
Nazwa | Opis | Wartość |
---|---|---|
defaultValue | Wartość parametru domyślnego | jakikolwiek |
oAuthSettings | Ustawienia definiujące przepływ protokołu OAuth dla dostawcy zaplecza | ApiOAuthSettings |
typ | Typ parametru | "tablica" "bool" "połączenie" "int" "oauthSetting" "object" "secureobject" "securestring" "ciąg" |
uiDefinition | Definicje interfejsu użytkownika | jakikolwiek |
Właściwości połączenia
Nazwa | Opis | Wartość |
---|---|---|
Api | rozszerzona nazwa dostawcy połączeń | ExpandedParentApiEntity |
changedTime | Sygnatura czasowa ostatniej zmiany połączenia. | struna |
createdTime | Sygnatura czasowa tworzenia połączenia | struna |
customParameterValues | Niestandardowe wartości ustawień logowania. | ConnectionPropertiesCustomParameterValues |
displayName | nazwa wyświetlana | struna |
firstExpirationTime | Czas w formacie UTC po pierwszym wygaśnięciu tokenów OAuth | struna |
Słowa kluczowe | Lista słów kluczowych tagujących listę acl | string[] |
metadane | Dowolny obiekt | jakikolwiek |
nazwa | nazwa połączenia | struna |
nonSecretParameterValues | Tokeny/oświadczenia | ConnectionPropertiesNonSecretParameterValues |
parameterValues | Tokeny/oświadczenia | ConnectionPropertiesParameterValues |
Statusy | Stan połączenia | ConnectionStatus[] |
tenantId | struna |
ConnectionPropertiesCustomParameterValues
Nazwa | Opis | Wartość |
---|
ConnectionPropertiesNonSecretParameterValues
Nazwa | Opis | Wartość |
---|
ConnectionPropertiesParameterValues
Nazwa | Opis | Wartość |
---|
ConnectionStatus
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | ConnectionStatusProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
ConnectionStatusProperties
Nazwa | Opis | Wartość |
---|---|---|
błąd | Szczegóły błędu | ConnectionError |
stan | Stan | struna |
cel | Element docelowy błędu | struna |
CustomLoginSettingValue
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | CustomLoginSettingValueProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
CustomLoginSettingValueProperties
Nazwa | Opis | Wartość |
---|---|---|
opcja | Opcja wybrana dla tej niestandardowej wartości ustawienia logowania | struna |
ExpandedParentApiEntity
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | ExpandedParentApiEntityProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
ExpandedParentApiEntityProperties
Nazwa | Opis | Wartość |
---|---|---|
jednostka | Identyfikator dostawcy połączenia | ResponseMessageEnvelopeApiEntity |
id | Identyfikator dostawcy połączenia | struna |
GeneralApiInformation
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | GeneralApiInformationProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
OgólneApiInformationProperties
Nazwa | Opis | Wartość |
---|---|---|
connectionDisplayName | DefaultConnectionNameTemplate | struna |
connectionPortalUrl | ConnectionPortalUrl | jakikolwiek |
opis | Opis | struna |
displayName | Nazwa wyświetlana | struna |
iconUrl | Adres URL ikony | struna |
termsOfUseUrl | publiczny adres URL warunków użytkowania tego interfejsu API | struna |
HostingEnvironmentServiceDescriptions
Nazwa | Opis | Wartość |
---|---|---|
hostId | Identyfikator hosta | struna |
hostingEnvironmentId | Identyfikator środowiska hostingu | struna |
serviceUrl | adres URL usługi do użycia | struna |
useInternalRouting | Gdy adres URL zaplecza znajduje się w tym samym środowisku ASE, z powodu wydajności tę flagę można ustawić na true Jeśli parametr WebApp.DisableHostNames jest również ustawiony, zwiększa bezpieczeństwo przez udostępnienie zaplecza tylko za pośrednictwem wywołań interfejsu API Uwaga: wywołania zakończą się niepowodzeniem, jeśli ta opcja jest używana, ale zaplecze nie znajduje się w tym samym ase |
Bool |
Microsoft.Web/connections
Nazwa | Opis | Wartość |
---|---|---|
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | ciąg (wymagany) |
Właściwości | ConnectionProperties | |
Tagi | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
ParametrCustomLoginSettingValues
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | parametr CustomLoginSettingValuesProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
ParameterCustomLoginSettingValuesProperties
Nazwa | Opis | Wartość |
---|---|---|
customParameters | Parametry niestandardowe. | parametr CustomLoginSettingValuesPropertiesCustomParameters |
ParametrCustomLoginSettingValuesPropertiesCustomParameters
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
ResponseMessageEnvelopeApiEntity
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu. Zazwyczaj identyfikator jest wypełniany tylko dla odpowiedzi na żądania GET. Obiekt wywołujący jest odpowiedzialny za przekazanie tego elementu wartość tylko dla żądań GET. Na przykład: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} |
struna |
lokalizacja | Zasób regionu geograficznego należy do np. SouthCentralUS, SouthEastAsia | struna |
nazwa | Nazwa zasobu | struna |
plan | Plan usługi Azure Resource Manager | ArmPlan |
Właściwości | Właściwości specyficzne dla zasobu | ApiEntity |
Numer jednostki magazynowej | Opis jednostki SKU zasobu | SkuDescription |
Tagi | Tagi skojarzone z zasobem | ResponseMessageEnvelopeApiEntityTags |
typ | Typ zasobu, np. Microsoft.Web/sites | struna |
ResponseMessageEnvelopeApiEntityTags
Nazwa | Opis | Wartość |
---|
SkuDescription
Nazwa | Opis | Wartość |
---|---|---|
pojemność | Bieżąca liczba wystąpień przypisanych do zasobu | Int |
rodzina | Kod rodziny jednostki SKU zasobu | struna |
nazwa | Nazwa jednostki SKU zasobu | struna |
rozmiar | Specyfikator rozmiaru jednostki SKU zasobu | struna |
kondygnacja | Warstwa usługi jednostki SKU zasobu | struna |
Przykłady z przewodnika Szybki start
W poniższych przykładach szybkiego startu wdrożono ten typ zasobu.
Plik Bicep | Opis |
---|---|
Azure Logic Apps — as2 wysyłanie odbierania | Tworzy konta integracji dla dwóch partnerów, Contoso i Fabrikam, w tym artefakty dla partnerów i umów. Szablon tworzy również aplikacje logiki między firmą Fabrikam Sales i Firmą Contoso w celu zademonstrowania synchronicznego odbierania wysyłania AS2. Szablon tworzy również aplikacje logiki między firmami Fabrikam Finance i Contoso, które pokazują asynchroniczne odbieranie asynchronicznych wiadomości AS2. |
kopiowanie plików FTP do aplikacji logiki obiektów blob platformy Azure | Ten szablon umożliwia tworzenie wyzwalaczy aplikacji logiki na plikach na serwerze FTP i kopiowanie ich do kontenera obiektów blob platformy Azure. Możesz dodać dodatkowe wyzwalacze lub akcje, aby dostosować je do własnych potrzeb. |
pobieranie kluczy dostępu usługi Azure Storage w szablonie usługi ARM | Ten szablon utworzy konto magazynu, po którym utworzy połączenie interfejsu API, dynamicznie pobierając klucz podstawowy konta magazynu. Połączenie interfejsu API jest następnie używane w aplikacji logiki jako wyzwalacz sondowania pod kątem zmian obiektów blob. |
Definicja zasobu szablonu usługi ARM
Typ zasobu połączeń 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.Web/connections, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.Web/connections",
"apiVersion": "2015-08-01-preview",
"name": "string",
"kind": "string",
"location": "string",
"properties": {
"api": {
"id": "string",
"kind": "string",
"location": "string",
"name": "string",
"properties": {
"entity": {
"id": "string",
"location": "string",
"name": "string",
"plan": {
"name": "string",
"product": "string",
"promotionCode": "string",
"publisher": "string",
"version": "string"
},
"properties": {
"id": "string",
"kind": "string",
"location": "string",
"name": "string",
"properties": {
"apiDefinitionUrl": "string",
"backendService": {
"id": "string",
"kind": "string",
"location": "string",
"name": "string",
"properties": {
"hostingEnvironmentServiceUrls": [
{
"hostId": "string",
"hostingEnvironmentId": "string",
"serviceUrl": "string",
"useInternalRouting": "bool"
}
],
"serviceUrl": "string"
},
"tags": {
"{customized property}": "string"
},
"type": "string"
},
"capabilities": [ "string" ],
"changedTime": "string",
"connectionParameters": {
"{customized property}": {
"defaultValue": {},
"oAuthSettings": {
"clientId": "string",
"clientSecret": "string",
"customParameters": {
"{customized property}": {
"options": {},
"uiDefinition": {},
"value": "string"
}
},
"identityProvider": "string",
"properties": {},
"redirectUrl": "string",
"scopes": [ "string" ]
},
"type": "string",
"uiDefinition": {}
}
},
"createdTime": "string",
"generalInformation": {
"id": "string",
"kind": "string",
"location": "string",
"name": "string",
"properties": {
"connectionDisplayName": "string",
"connectionPortalUrl": {},
"description": "string",
"displayName": "string",
"iconUrl": "string",
"termsOfUseUrl": "string"
},
"tags": {
"{customized property}": "string"
},
"type": "string"
},
"metadata": {},
"name": "string",
"path": "string",
"policies": {
"id": "string",
"kind": "string",
"location": "string",
"name": "string",
"properties": {
"content": "string"
},
"tags": {
"{customized property}": "string"
},
"type": "string"
},
"protocols": [ "string" ],
"runtimeUrls": [ "string" ]
},
"tags": {
"{customized property}": "string"
},
"type": "string"
},
"sku": {
"capacity": "int",
"family": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
},
"type": "string"
},
"id": "string"
},
"tags": {
"{customized property}": "string"
},
"type": "string"
},
"changedTime": "string",
"createdTime": "string",
"customParameterValues": {
"{customized property}": {
"id": "string",
"kind": "string",
"location": "string",
"name": "string",
"properties": {
"customParameters": {
"{customized property}": {
"id": "string",
"kind": "string",
"location": "string",
"name": "string",
"properties": {
"option": "string"
},
"tags": {
"{customized property}": "string"
},
"type": "string"
}
}
},
"tags": {
"{customized property}": "string"
},
"type": "string"
}
},
"displayName": "string",
"firstExpirationTime": "string",
"keywords": [ "string" ],
"metadata": {},
"name": "string",
"nonSecretParameterValues": {
"{customized property}": {}
},
"parameterValues": {
"{customized property}": {}
},
"statuses": [
{
"id": "string",
"kind": "string",
"location": "string",
"name": "string",
"properties": {
"error": {
"id": "string",
"kind": "string",
"location": "string",
"name": "string",
"properties": {
"code": "string",
"message": "string"
},
"tags": {
"{customized property}": "string"
},
"type": "string"
},
"status": "string",
"target": "string"
},
"tags": {
"{customized property}": "string"
},
"type": "string"
}
],
"tenantId": "string"
},
"tags": {
"{customized property}": "string"
}
}
Wartości właściwości
ApiEntity
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | ApiEntityProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
ApiEntityProperties
Nazwa | Opis | Wartość |
---|---|---|
apiDefinitionUrl | Adres URL definicji interfejsu API — adres URL, z którego można pobrać program Swagger | struna |
backendService | Definicja usługi zaplecza | BackendServiceDefinition |
Możliwości | Możliwości | string[] |
changedTime | Sygnatura czasowa ostatniej zmiany połączenia. | struna |
connectionParameters | Parametry połączenia | ApiEntityPropertiesConnectionParameters |
createdTime | Sygnatura czasowa tworzenia połączenia | struna |
generalInformation | ścieżka adresu URL tego interfejsu API w przypadku uwidocznienia za pośrednictwem usługi APIM | GeneralApiInformation |
metadane | Dowolny obiekt formularza dla obiektu wywołującego dane chce przechowywać | jakikolwiek |
nazwa | Nazwa interfejsu API ścieżka adresu URL tego interfejsu API w przypadku uwidocznienia za pośrednictwem usługi APIM |
struna |
ścieżka | ścieżka adresu URL tego interfejsu API w przypadku uwidocznienia za pośrednictwem usługi APIM | struna |
manifest | Zasady interfejsu API | ApiPolicies |
Protokołów | Protokoły obsługiwane przez fronton — http/https | string[] |
runtimeUrls | Właściwość tylko do odczytu zwracająca punkty końcowe środowiska uruchomieniowego, w których można wywołać interfejs API | string[] |
ApiEntityPropertiesConnectionParameters
Nazwa | Opis | Wartość |
---|
ApiOAuthSettings
Nazwa | Opis | Wartość |
---|---|---|
clientId | Identyfikator klienta dostawcy zasobów | struna |
clientSecret | Klucz tajny klienta wymagany do uwierzytelniania OAuth | struna |
customParameters | Klucz parametrów OAuth to nazwa parametru | ApiOAuthSettingsCustomParameters |
identityProvider | Dostawca tożsamości | struna |
Właściwości | Właściwości tylko do odczytu dla tego ustawienia oauth. | jakikolwiek |
redirectUrl | Adres URL | struna |
Zakresów | Zakresy OAuth | string[] |
ApiOAuthSettingsCustomParameters
Nazwa | Opis | Wartość |
---|
ApiOAuthSettingsParameter
Nazwa | Opis | Wartość |
---|---|---|
Opcje | Tylko do odczytu: opcje dostępne dla tego parametru | jakikolwiek |
uiDefinition | Definicje interfejsu użytkownika na kulturę, ponieważ obiekt wywołujący może określić kulturę | jakikolwiek |
wartość | Wartość | struna |
ApiPolicies
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | ApiPoliciesProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
ApiPoliciesProperties
Nazwa | Opis | Wartość |
---|---|---|
zawartość | Zawartość zasad xml | struna |
ArmPlan
Nazwa | Opis | Wartość |
---|---|---|
nazwa | Nazwa | struna |
produkt | Produkt | struna |
kod podwyższania poziomu | Kod podwyższania poziomu | struna |
wydawca | Wydawca | struna |
Wersja | Wersja produktu | struna |
BackendServiceDefinition
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | BackendServiceDefinitionProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
BackendServiceDefinitionProperties
Nazwa | Opis | Wartość |
---|---|---|
hostingEnvironmentServiceUrls | Adresy URL usług na środowisko hostingu | HostingEnvironmentServiceDescriptions[] |
serviceUrl | Adres URL, z którego zostanie pobrany ładunek struktury Swagger | struna |
ConnectionError
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | ConnectionErrorProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
ConnectionErrorProperties
Nazwa | Opis | Wartość |
---|---|---|
kod | kod stanu | struna |
Komunikat | Opis stanu | struna |
Parametr połączenia
Nazwa | Opis | Wartość |
---|---|---|
defaultValue | Wartość parametru domyślnego | jakikolwiek |
oAuthSettings | Ustawienia definiujące przepływ protokołu OAuth dla dostawcy zaplecza | ApiOAuthSettings |
typ | Typ parametru | "tablica" "bool" "połączenie" "int" "oauthSetting" "object" "secureobject" "securestring" "ciąg" |
uiDefinition | Definicje interfejsu użytkownika | jakikolwiek |
Właściwości połączenia
Nazwa | Opis | Wartość |
---|---|---|
Api | rozszerzona nazwa dostawcy połączeń | ExpandedParentApiEntity |
changedTime | Sygnatura czasowa ostatniej zmiany połączenia. | struna |
createdTime | Sygnatura czasowa tworzenia połączenia | struna |
customParameterValues | Niestandardowe wartości ustawień logowania. | ConnectionPropertiesCustomParameterValues |
displayName | nazwa wyświetlana | struna |
firstExpirationTime | Czas w formacie UTC po pierwszym wygaśnięciu tokenów OAuth | struna |
Słowa kluczowe | Lista słów kluczowych tagujących listę acl | string[] |
metadane | Dowolny obiekt | jakikolwiek |
nazwa | nazwa połączenia | struna |
nonSecretParameterValues | Tokeny/oświadczenia | ConnectionPropertiesNonSecretParameterValues |
parameterValues | Tokeny/oświadczenia | ConnectionPropertiesParameterValues |
Statusy | Stan połączenia | ConnectionStatus[] |
tenantId | struna |
ConnectionPropertiesCustomParameterValues
Nazwa | Opis | Wartość |
---|
ConnectionPropertiesNonSecretParameterValues
Nazwa | Opis | Wartość |
---|
ConnectionPropertiesParameterValues
Nazwa | Opis | Wartość |
---|
ConnectionStatus
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | ConnectionStatusProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
ConnectionStatusProperties
Nazwa | Opis | Wartość |
---|---|---|
błąd | Szczegóły błędu | ConnectionError |
stan | Stan | struna |
cel | Element docelowy błędu | struna |
CustomLoginSettingValue
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | CustomLoginSettingValueProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
CustomLoginSettingValueProperties
Nazwa | Opis | Wartość |
---|---|---|
opcja | Opcja wybrana dla tej niestandardowej wartości ustawienia logowania | struna |
ExpandedParentApiEntity
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | ExpandedParentApiEntityProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
ExpandedParentApiEntityProperties
Nazwa | Opis | Wartość |
---|---|---|
jednostka | Identyfikator dostawcy połączenia | ResponseMessageEnvelopeApiEntity |
id | Identyfikator dostawcy połączenia | struna |
GeneralApiInformation
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | GeneralApiInformationProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
OgólneApiInformationProperties
Nazwa | Opis | Wartość |
---|---|---|
connectionDisplayName | DefaultConnectionNameTemplate | struna |
connectionPortalUrl | ConnectionPortalUrl | jakikolwiek |
opis | Opis | struna |
displayName | Nazwa wyświetlana | struna |
iconUrl | Adres URL ikony | struna |
termsOfUseUrl | publiczny adres URL warunków użytkowania tego interfejsu API | struna |
HostingEnvironmentServiceDescriptions
Nazwa | Opis | Wartość |
---|---|---|
hostId | Identyfikator hosta | struna |
hostingEnvironmentId | Identyfikator środowiska hostingu | struna |
serviceUrl | adres URL usługi do użycia | struna |
useInternalRouting | Gdy adres URL zaplecza znajduje się w tym samym środowisku ASE, z powodu wydajności tę flagę można ustawić na true Jeśli parametr WebApp.DisableHostNames jest również ustawiony, zwiększa bezpieczeństwo przez udostępnienie zaplecza tylko za pośrednictwem wywołań interfejsu API Uwaga: wywołania zakończą się niepowodzeniem, jeśli ta opcja jest używana, ale zaplecze nie znajduje się w tym samym ase |
Bool |
Microsoft.Web/connections
Nazwa | Opis | Wartość |
---|---|---|
apiVersion | Wersja interfejsu API | "2015-08-01-preview" |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | ciąg (wymagany) |
Właściwości | ConnectionProperties | |
Tagi | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
typ | Typ zasobu | "Microsoft.Web/connections" |
ParametrCustomLoginSettingValues
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | parametr CustomLoginSettingValuesProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
ParameterCustomLoginSettingValuesProperties
Nazwa | Opis | Wartość |
---|---|---|
customParameters | Parametry niestandardowe. | parametr CustomLoginSettingValuesPropertiesCustomParameters |
ParametrCustomLoginSettingValuesPropertiesCustomParameters
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
ResponseMessageEnvelopeApiEntity
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu. Zazwyczaj identyfikator jest wypełniany tylko dla odpowiedzi na żądania GET. Obiekt wywołujący jest odpowiedzialny za przekazanie tego elementu wartość tylko dla żądań GET. Na przykład: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} |
struna |
lokalizacja | Zasób regionu geograficznego należy do np. SouthCentralUS, SouthEastAsia | struna |
nazwa | Nazwa zasobu | struna |
plan | Plan usługi Azure Resource Manager | ArmPlan |
Właściwości | Właściwości specyficzne dla zasobu | ApiEntity |
Numer jednostki magazynowej | Opis jednostki SKU zasobu | SkuDescription |
Tagi | Tagi skojarzone z zasobem | ResponseMessageEnvelopeApiEntityTags |
typ | Typ zasobu, np. Microsoft.Web/sites | struna |
ResponseMessageEnvelopeApiEntityTags
Nazwa | Opis | Wartość |
---|
SkuDescription
Nazwa | Opis | Wartość |
---|---|---|
pojemność | Bieżąca liczba wystąpień przypisanych do zasobu | Int |
rodzina | Kod rodziny jednostki SKU zasobu | struna |
nazwa | Nazwa jednostki SKU zasobu | struna |
rozmiar | Specyfikator rozmiaru jednostki SKU zasobu | struna |
kondygnacja | Warstwa usługi jednostki SKU zasobu | struna |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
Szablon | Opis |
---|---|
Alert do kolejki przy użyciu aplikacji logiki wdrażanie |
Ten szablon umożliwia utworzenie aplikacji logiki z elementem webhook. Po wyzwoleniu aplikacji logiki zostanie dodany ładunek przekazywany do określonej kolejki usługi Azure Storage. Możesz dodać ten element webhook do alertu platformy Azure, a następnie za każdym razem, gdy alert zostanie wyzwolony, otrzymasz ten element w kolejce. |
alert do usługi Slack z aplikacją logiki wdrażanie |
Ten szablon umożliwia utworzenie aplikacji logiki, która ma element webhook do użycia z poziomu alertu platformy Azure. Po wyzwoleniu alertu zostanie wyświetlony komunikat do określonego kanału usługi Slack. Aby użyć tego szablonu, musisz mieć konto usługi Slack. |
alert do wiadomości SMS z aplikacją logiki wdrażanie |
Ten szablon umożliwia utworzenie aplikacji logiki, która ma element webhook do użycia z poziomu alertu platformy Azure. Po wyzwoleniu alertu zostanie wysłana wiadomość SMS ze szczegółami alertu. Używa ona go.gl usługi skracania adresu URL, aby dołączyć link do portalu, aby wyświetlić zasób. |
Azure Logic Apps — as2 wysyłanie odbierania wdrażanie |
Tworzy konta integracji dla dwóch partnerów, Contoso i Fabrikam, w tym artefakty dla partnerów i umów. Szablon tworzy również aplikacje logiki między firmą Fabrikam Sales i Firmą Contoso w celu zademonstrowania synchronicznego odbierania wysyłania AS2. Szablon tworzy również aplikacje logiki między firmami Fabrikam Finance i Contoso, które pokazują asynchroniczne odbieranie asynchronicznych wiadomości AS2. |
Azure Logic Apps — replikacja odzyskiwania po awarii B2B wdrażanie |
Tworzy replikację usługi Logic Apps for AS2 MIC, wygenerowanych i odebranych numerów kontrolnych X12. Wyzwalacz każdej aplikacji logiki wskazuje konto integracji lokacji głównej. Każda akcja aplikacji logiki wskazuje konto integracji lokacji dodatkowej. |
kopiowanie plików FTP do aplikacji logiki obiektów blob platformy Azure wdrażanie |
Ten szablon umożliwia tworzenie wyzwalaczy aplikacji logiki na plikach na serwerze FTP i kopiowanie ich do kontenera obiektów blob platformy Azure. Możesz dodać dodatkowe wyzwalacze lub akcje, aby dostosować je do własnych potrzeb. |
korelowanie komunikatów za pośrednictwem usługi Logic Apps przy użyciu usługi Service Bus wdrażanie |
który pokazuje, jak możemy skorelować komunikaty za pośrednictwem usługi Logic Apps przy użyciu usługi Azure Service Bus |
aplikacji logiki do wiadomości e-mail ze szczegółowymi raportami kopii zapasowych wdrażanie |
Utwórz aplikację logiki, aby wysyłać raporty dotyczące wystąpień kopii zapasowych, użycia, zadań, zasad, przestrzegania zasad i możliwości optymalizacji za pośrednictwem poczty e-mail. |
aplikacja logiki wysyła do wiadomości e-mail raporty dotyczące zadań tworzenia kopii zapasowych i przywracania wdrażanie |
Tworzenie aplikacji logiki do wysyłania raportów dotyczących zadań tworzenia kopii zapasowej i przywracania za pośrednictwem poczty e-mail |
aplikacja logiki do wiadomości e-mail z raportami na temat optymalizacji kosztów tworzenia kopii zapasowych wdrażanie |
Ten szablon wdraża aplikację logiki, która wysyła okresowe raporty dotyczące nieaktywnych zasobów kopii zapasowych, możliwych optymalizacji harmonogramu tworzenia kopii zapasowych i możliwych optymalizacji przechowywania kopii zapasowych do określonego zestawu adresów e-mail. |
aplikacji logiki do poczty e-mail w raportach dotyczących wystąpień kopii zapasowych wdrażanie |
Tworzenie aplikacji logiki do wysyłania raportów dotyczących wystąpień kopii zapasowych chronionych przy użyciu usługi Azure Backup za pośrednictwem poczty e-mail |
aplikacji logiki do wiadomości e-mail z raportami dotyczącymi zasad tworzenia kopii zapasowych wdrażanie |
Tworzenie aplikacji logiki do wysyłania raportów dotyczących zasad tworzenia kopii zapasowych za pośrednictwem poczty e-mail |
aplikacja logiki do wiadomości e-mail z raportami na temat przestrzegania zasad kopii zapasowych wdrażanie |
Tworzenie aplikacji logiki w celu wysyłania raportów dotyczących przestrzegania zasad kopii zapasowych wystąpień kopii zapasowych za pośrednictwem poczty e-mail |
aplikacji logiki do obsługi poczty e-mail w raportach dotyczących rozliczeń usługi Azure Backup wdrażanie |
Ten szablon wdraża aplikację logiki, która wysyła okresowe raporty dotyczące kluczowych parametrów rozliczeń kopii zapasowych (chronione wystąpienia i używany magazyn kopii zapasowych w chmurze) na poziomie jednostki rozliczeniowej do określonego zestawu adresów e-mail. |
aplikacji logiki do wiadomości e-mail z podsumowaniem raportów dotyczących kopii zapasowych wdrażanie |
Utwórz aplikację logiki, aby wysyłać raporty podsumowania kopii zapasowych za pośrednictwem poczty e-mail. |
pobieranie kluczy dostępu usługi Azure Storage w szablonie usługi ARM wdrażanie |
Ten szablon utworzy konto magazynu, po którym utworzy połączenie interfejsu API, dynamicznie pobierając klucz podstawowy konta magazynu. Połączenie interfejsu API jest następnie używane w aplikacji logiki jako wyzwalacz sondowania pod kątem zmian obiektów blob. |
uruchamianie procedury składowanej SQL zgodnie z harmonogramem za pośrednictwem aplikacji logiki wdrażanie |
Ten szablon umożliwia utworzenie aplikacji logiki, która będzie uruchamiać procedurę składowaną SQL zgodnie z harmonogramem. Wszelkie argumenty procedury można umieścić w sekcji treści szablonu. |
Wysyłanie wiadomości e-mail przy użyciu aplikacji logiki wdrażanie |
Ten szablon umożliwia utworzenie aplikacji logiki, która wysyła wiadomość e-mail. Możesz dodać dodatkowe wyzwalacze lub akcje, aby dostosować je do własnych potrzeb. |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu połączeń 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.Web/connections, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Web/connections@2015-08-01-preview"
name = "string"
kind = "string"
location = "string"
body = jsonencode({
properties = {
api = {
id = "string"
kind = "string"
location = "string"
name = "string"
properties = {
entity = {
id = "string"
location = "string"
name = "string"
plan = {
name = "string"
product = "string"
promotionCode = "string"
publisher = "string"
version = "string"
}
properties = {
id = "string"
kind = "string"
location = "string"
name = "string"
properties = {
apiDefinitionUrl = "string"
backendService = {
id = "string"
kind = "string"
location = "string"
name = "string"
properties = {
hostingEnvironmentServiceUrls = [
{
hostId = "string"
hostingEnvironmentId = "string"
serviceUrl = "string"
useInternalRouting = bool
}
]
serviceUrl = "string"
}
tags = {
{customized property} = "string"
}
type = "string"
}
capabilities = [
"string"
]
changedTime = "string"
connectionParameters = {
{customized property} = {
defaultValue = ?
oAuthSettings = {
clientId = "string"
clientSecret = "string"
customParameters = {
{customized property} = {
options = ?
uiDefinition = ?
value = "string"
}
}
identityProvider = "string"
properties = ?
redirectUrl = "string"
scopes = [
"string"
]
}
type = "string"
uiDefinition = ?
}
}
createdTime = "string"
generalInformation = {
id = "string"
kind = "string"
location = "string"
name = "string"
properties = {
connectionDisplayName = "string"
connectionPortalUrl = ?
description = "string"
displayName = "string"
iconUrl = "string"
termsOfUseUrl = "string"
}
tags = {
{customized property} = "string"
}
type = "string"
}
metadata = ?
name = "string"
path = "string"
policies = {
id = "string"
kind = "string"
location = "string"
name = "string"
properties = {
content = "string"
}
tags = {
{customized property} = "string"
}
type = "string"
}
protocols = [
"string"
]
runtimeUrls = [
"string"
]
}
tags = {
{customized property} = "string"
}
type = "string"
}
sku = {
capacity = int
family = "string"
name = "string"
size = "string"
tier = "string"
}
tags = {
{customized property} = "string"
}
type = "string"
}
id = "string"
}
tags = {
{customized property} = "string"
}
type = "string"
}
changedTime = "string"
createdTime = "string"
customParameterValues = {
{customized property} = {
id = "string"
kind = "string"
location = "string"
name = "string"
properties = {
customParameters = {
{customized property} = {
id = "string"
kind = "string"
location = "string"
name = "string"
properties = {
option = "string"
}
tags = {
{customized property} = "string"
}
type = "string"
}
}
}
tags = {
{customized property} = "string"
}
type = "string"
}
}
displayName = "string"
firstExpirationTime = "string"
keywords = [
"string"
]
metadata = ?
name = "string"
nonSecretParameterValues = {
{customized property} = ?
}
parameterValues = {
{customized property} = ?
}
statuses = [
{
id = "string"
kind = "string"
location = "string"
name = "string"
properties = {
error = {
id = "string"
kind = "string"
location = "string"
name = "string"
properties = {
code = "string"
message = "string"
}
tags = {
{customized property} = "string"
}
type = "string"
}
status = "string"
target = "string"
}
tags = {
{customized property} = "string"
}
type = "string"
}
]
tenantId = "string"
}
})
tags = {
{customized property} = "string"
}
}
Wartości właściwości
ApiEntity
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | ApiEntityProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
ApiEntityProperties
Nazwa | Opis | Wartość |
---|---|---|
apiDefinitionUrl | Adres URL definicji interfejsu API — adres URL, z którego można pobrać program Swagger | struna |
backendService | Definicja usługi zaplecza | BackendServiceDefinition |
Możliwości | Możliwości | string[] |
changedTime | Sygnatura czasowa ostatniej zmiany połączenia. | struna |
connectionParameters | Parametry połączenia | ApiEntityPropertiesConnectionParameters |
createdTime | Sygnatura czasowa tworzenia połączenia | struna |
generalInformation | ścieżka adresu URL tego interfejsu API w przypadku uwidocznienia za pośrednictwem usługi APIM | GeneralApiInformation |
metadane | Dowolny obiekt formularza dla obiektu wywołującego dane chce przechowywać | jakikolwiek |
nazwa | Nazwa interfejsu API ścieżka adresu URL tego interfejsu API w przypadku uwidocznienia za pośrednictwem usługi APIM |
struna |
ścieżka | ścieżka adresu URL tego interfejsu API w przypadku uwidocznienia za pośrednictwem usługi APIM | struna |
manifest | Zasady interfejsu API | ApiPolicies |
Protokołów | Protokoły obsługiwane przez fronton — http/https | string[] |
runtimeUrls | Właściwość tylko do odczytu zwracająca punkty końcowe środowiska uruchomieniowego, w których można wywołać interfejs API | string[] |
ApiEntityPropertiesConnectionParameters
Nazwa | Opis | Wartość |
---|
ApiOAuthSettings
Nazwa | Opis | Wartość |
---|---|---|
clientId | Identyfikator klienta dostawcy zasobów | struna |
clientSecret | Klucz tajny klienta wymagany do uwierzytelniania OAuth | struna |
customParameters | Klucz parametrów OAuth to nazwa parametru | ApiOAuthSettingsCustomParameters |
identityProvider | Dostawca tożsamości | struna |
Właściwości | Właściwości tylko do odczytu dla tego ustawienia oauth. | jakikolwiek |
redirectUrl | Adres URL | struna |
Zakresów | Zakresy OAuth | string[] |
ApiOAuthSettingsCustomParameters
Nazwa | Opis | Wartość |
---|
ApiOAuthSettingsParameter
Nazwa | Opis | Wartość |
---|---|---|
Opcje | Tylko do odczytu: opcje dostępne dla tego parametru | jakikolwiek |
uiDefinition | Definicje interfejsu użytkownika na kulturę, ponieważ obiekt wywołujący może określić kulturę | jakikolwiek |
wartość | Wartość | struna |
ApiPolicies
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | ApiPoliciesProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
ApiPoliciesProperties
Nazwa | Opis | Wartość |
---|---|---|
zawartość | Zawartość zasad xml | struna |
ArmPlan
Nazwa | Opis | Wartość |
---|---|---|
nazwa | Nazwa | struna |
produkt | Produkt | struna |
kod podwyższania poziomu | Kod podwyższania poziomu | struna |
wydawca | Wydawca | struna |
Wersja | Wersja produktu | struna |
BackendServiceDefinition
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | BackendServiceDefinitionProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
BackendServiceDefinitionProperties
Nazwa | Opis | Wartość |
---|---|---|
hostingEnvironmentServiceUrls | Adresy URL usług na środowisko hostingu | HostingEnvironmentServiceDescriptions[] |
serviceUrl | Adres URL, z którego zostanie pobrany ładunek struktury Swagger | struna |
ConnectionError
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | ConnectionErrorProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
ConnectionErrorProperties
Nazwa | Opis | Wartość |
---|---|---|
kod | kod stanu | struna |
Komunikat | Opis stanu | struna |
Parametr połączenia
Nazwa | Opis | Wartość |
---|---|---|
defaultValue | Wartość parametru domyślnego | jakikolwiek |
oAuthSettings | Ustawienia definiujące przepływ protokołu OAuth dla dostawcy zaplecza | ApiOAuthSettings |
typ | Typ parametru | "tablica" "bool" "połączenie" "int" "oauthSetting" "object" "secureobject" "securestring" "ciąg" |
uiDefinition | Definicje interfejsu użytkownika | jakikolwiek |
Właściwości połączenia
Nazwa | Opis | Wartość |
---|---|---|
Api | rozszerzona nazwa dostawcy połączeń | ExpandedParentApiEntity |
changedTime | Sygnatura czasowa ostatniej zmiany połączenia. | struna |
createdTime | Sygnatura czasowa tworzenia połączenia | struna |
customParameterValues | Niestandardowe wartości ustawień logowania. | ConnectionPropertiesCustomParameterValues |
displayName | nazwa wyświetlana | struna |
firstExpirationTime | Czas w formacie UTC po pierwszym wygaśnięciu tokenów OAuth | struna |
Słowa kluczowe | Lista słów kluczowych tagujących listę acl | string[] |
metadane | Dowolny obiekt | jakikolwiek |
nazwa | nazwa połączenia | struna |
nonSecretParameterValues | Tokeny/oświadczenia | ConnectionPropertiesNonSecretParameterValues |
parameterValues | Tokeny/oświadczenia | ConnectionPropertiesParameterValues |
Statusy | Stan połączenia | ConnectionStatus[] |
tenantId | struna |
ConnectionPropertiesCustomParameterValues
Nazwa | Opis | Wartość |
---|
ConnectionPropertiesNonSecretParameterValues
Nazwa | Opis | Wartość |
---|
ConnectionPropertiesParameterValues
Nazwa | Opis | Wartość |
---|
ConnectionStatus
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | ConnectionStatusProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
ConnectionStatusProperties
Nazwa | Opis | Wartość |
---|---|---|
błąd | Szczegóły błędu | ConnectionError |
stan | Stan | struna |
cel | Element docelowy błędu | struna |
CustomLoginSettingValue
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | CustomLoginSettingValueProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
CustomLoginSettingValueProperties
Nazwa | Opis | Wartość |
---|---|---|
opcja | Opcja wybrana dla tej niestandardowej wartości ustawienia logowania | struna |
ExpandedParentApiEntity
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | ExpandedParentApiEntityProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
ExpandedParentApiEntityProperties
Nazwa | Opis | Wartość |
---|---|---|
jednostka | Identyfikator dostawcy połączenia | ResponseMessageEnvelopeApiEntity |
id | Identyfikator dostawcy połączenia | struna |
GeneralApiInformation
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | GeneralApiInformationProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
OgólneApiInformationProperties
Nazwa | Opis | Wartość |
---|---|---|
connectionDisplayName | DefaultConnectionNameTemplate | struna |
connectionPortalUrl | ConnectionPortalUrl | jakikolwiek |
opis | Opis | struna |
displayName | Nazwa wyświetlana | struna |
iconUrl | Adres URL ikony | struna |
termsOfUseUrl | publiczny adres URL warunków użytkowania tego interfejsu API | struna |
HostingEnvironmentServiceDescriptions
Nazwa | Opis | Wartość |
---|---|---|
hostId | Identyfikator hosta | struna |
hostingEnvironmentId | Identyfikator środowiska hostingu | struna |
serviceUrl | adres URL usługi do użycia | struna |
useInternalRouting | Gdy adres URL zaplecza znajduje się w tym samym środowisku ASE, z powodu wydajności tę flagę można ustawić na true Jeśli parametr WebApp.DisableHostNames jest również ustawiony, zwiększa bezpieczeństwo przez udostępnienie zaplecza tylko za pośrednictwem wywołań interfejsu API Uwaga: wywołania zakończą się niepowodzeniem, jeśli ta opcja jest używana, ale zaplecze nie znajduje się w tym samym ase |
Bool |
Microsoft.Web/connections
Nazwa | Opis | Wartość |
---|---|---|
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | ciąg (wymagany) |
Właściwości | ConnectionProperties | |
Tagi | Tagi zasobów | Słownik nazw tagów i wartości. |
typ | Typ zasobu | "Microsoft.Web/connections@2015-08-01-preview" |
ParametrCustomLoginSettingValues
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu | struna |
rodzaj | Rodzaj zasobu | struna |
lokalizacja | Lokalizacja zasobu | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna |
Właściwości | parametr CustomLoginSettingValuesProperties | |
Tagi | Tagi zasobów | |
typ | Typ zasobu | struna |
ParameterCustomLoginSettingValuesProperties
Nazwa | Opis | Wartość |
---|---|---|
customParameters | Parametry niestandardowe. | parametr CustomLoginSettingValuesPropertiesCustomParameters |
ParametrCustomLoginSettingValuesPropertiesCustomParameters
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
Tagi zasobów
Nazwa | Opis | Wartość |
---|
ResponseMessageEnvelopeApiEntity
Nazwa | Opis | Wartość |
---|---|---|
id | Identyfikator zasobu. Zazwyczaj identyfikator jest wypełniany tylko dla odpowiedzi na żądania GET. Obiekt wywołujący jest odpowiedzialny za przekazanie tego elementu wartość tylko dla żądań GET. Na przykład: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} |
struna |
lokalizacja | Zasób regionu geograficznego należy do np. SouthCentralUS, SouthEastAsia | struna |
nazwa | Nazwa zasobu | struna |
plan | Plan usługi Azure Resource Manager | ArmPlan |
Właściwości | Właściwości specyficzne dla zasobu | ApiEntity |
Numer jednostki magazynowej | Opis jednostki SKU zasobu | SkuDescription |
Tagi | Tagi skojarzone z zasobem | ResponseMessageEnvelopeApiEntityTags |
typ | Typ zasobu, np. Microsoft.Web/sites | struna |
ResponseMessageEnvelopeApiEntityTags
Nazwa | Opis | Wartość |
---|
SkuDescription
Nazwa | Opis | Wartość |
---|---|---|
pojemność | Bieżąca liczba wystąpień przypisanych do zasobu | Int |
rodzina | Kod rodziny jednostki SKU zasobu | struna |
nazwa | Nazwa jednostki SKU zasobu | struna |
rozmiar | Specyfikator rozmiaru jednostki SKU zasobu | struna |
kondygnacja | Warstwa usługi jednostki SKU zasobu | struna |