276 строки
20 KiB
YAML
276 строки
20 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.appservice.models.FunctionApp"
|
|
fullName: "com.azure.resourcemanager.appservice.models.FunctionApp"
|
|
name: "FunctionApp"
|
|
nameWithType: "FunctionApp"
|
|
summary: "An immutable client-side representation of an Azure Function App."
|
|
syntax: "public interface **FunctionApp**</br> extends <xref href=\"com.azure.resourcemanager.appservice.models.FunctionAppBasic?alt=com.azure.resourcemanager.appservice.models.FunctionAppBasic&text=FunctionAppBasic\" data-throw-if-not-resolved=\"False\" />, <xref href=\"com.azure.resourcemanager.appservice.models.WebAppBase?alt=com.azure.resourcemanager.appservice.models.WebAppBase&text=WebAppBase\" data-throw-if-not-resolved=\"False\" />, <xref href=\"com.azure.resourcemanager.resources.fluentcore.model.Updatable?alt=com.azure.resourcemanager.resources.fluentcore.model.Updatable&text=Updatable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.appservice.models.FunctionApp.Update?alt=com.azure.resourcemanager.appservice.models.FunctionApp.Update&text=Update\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateLinkResource?alt=com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateLinkResource&text=SupportsListingPrivateLinkResource\" data-throw-if-not-resolved=\"False\" />, <xref href=\"com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateEndpointConnection?alt=com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateEndpointConnection&text=SupportsListingPrivateEndpointConnection\" data-throw-if-not-resolved=\"False\" />, <xref href=\"com.azure.resourcemanager.resources.fluentcore.collection.SupportsUpdatingPrivateEndpointConnection?alt=com.azure.resourcemanager.resources.fluentcore.collection.SupportsUpdatingPrivateEndpointConnection&text=SupportsUpdatingPrivateEndpointConnection\" data-throw-if-not-resolved=\"False\" />"
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.appservice.models.FunctionApp.addFunctionKey(java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.appservice.models.FunctionApp.addFunctionKey(String functionName, String keyName, String keyValue)"
|
|
name: "addFunctionKey(String functionName, String keyName, String keyValue)"
|
|
nameWithType: "FunctionApp.addFunctionKey(String functionName, String keyName, String keyValue)"
|
|
summary: "Adds a key to a function in this function app."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the name of the function"
|
|
name: "functionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "the name of the key to add"
|
|
name: "keyName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "optional. If not provided, a value will be generated."
|
|
name: "keyValue"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract NameValuePair addFunctionKey(String functionName, String keyName, String keyValue)"
|
|
desc: "Adds a key to a function in this function app."
|
|
returns:
|
|
description: "the added function key"
|
|
type: "<xref href=\"com.azure.resourcemanager.appservice.models.NameValuePair?alt=com.azure.resourcemanager.appservice.models.NameValuePair&text=NameValuePair\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.appservice.models.FunctionApp.addFunctionKeyAsync(java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.appservice.models.FunctionApp.addFunctionKeyAsync(String functionName, String keyName, String keyValue)"
|
|
name: "addFunctionKeyAsync(String functionName, String keyName, String keyValue)"
|
|
nameWithType: "FunctionApp.addFunctionKeyAsync(String functionName, String keyName, String keyValue)"
|
|
summary: "Adds a key to a function in this function app."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the name of the function"
|
|
name: "functionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "the name of the key to add"
|
|
name: "keyName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "optional. If not provided, a value will be generated."
|
|
name: "keyValue"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract Mono<NameValuePair> addFunctionKeyAsync(String functionName, String keyName, String keyValue)"
|
|
desc: "Adds a key to a function in this function app."
|
|
returns:
|
|
description: "the added function key"
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.resourcemanager.appservice.models.NameValuePair?alt=com.azure.resourcemanager.appservice.models.NameValuePair&text=NameValuePair\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.appservice.models.FunctionApp.deploymentSlots()"
|
|
fullName: "com.azure.resourcemanager.appservice.models.FunctionApp.deploymentSlots()"
|
|
name: "deploymentSlots()"
|
|
nameWithType: "FunctionApp.deploymentSlots()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract FunctionDeploymentSlots deploymentSlots()"
|
|
returns:
|
|
description: "the entry point to deployment slot management API under the function app"
|
|
type: "<xref href=\"com.azure.resourcemanager.appservice.models.FunctionDeploymentSlots?alt=com.azure.resourcemanager.appservice.models.FunctionDeploymentSlots&text=FunctionDeploymentSlots\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.appservice.models.FunctionApp.getMasterKey()"
|
|
fullName: "com.azure.resourcemanager.appservice.models.FunctionApp.getMasterKey()"
|
|
name: "getMasterKey()"
|
|
nameWithType: "FunctionApp.getMasterKey()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract String getMasterKey()"
|
|
returns:
|
|
description: "the master key for the function app"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.appservice.models.FunctionApp.getMasterKeyAsync()"
|
|
fullName: "com.azure.resourcemanager.appservice.models.FunctionApp.getMasterKeyAsync()"
|
|
name: "getMasterKeyAsync()"
|
|
nameWithType: "FunctionApp.getMasterKeyAsync()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Mono<String> getMasterKeyAsync()"
|
|
returns:
|
|
description: "the master key for the function app"
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- uid: "com.azure.resourcemanager.appservice.models.FunctionApp.listFunctionKeys(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.appservice.models.FunctionApp.listFunctionKeys(String functionName)"
|
|
name: "listFunctionKeys(String functionName)"
|
|
nameWithType: "FunctionApp.listFunctionKeys(String functionName)"
|
|
summary: "Retrieve the function key for a specific function."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the name of the function"
|
|
name: "functionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract Map<String,String> listFunctionKeys(String functionName)"
|
|
desc: "Retrieve the function key for a specific function."
|
|
returns:
|
|
description: "the function key"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- uid: "com.azure.resourcemanager.appservice.models.FunctionApp.listFunctionKeysAsync(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.appservice.models.FunctionApp.listFunctionKeysAsync(String functionName)"
|
|
name: "listFunctionKeysAsync(String functionName)"
|
|
nameWithType: "FunctionApp.listFunctionKeysAsync(String functionName)"
|
|
summary: "Retrieve the function key for a specific function."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the name of the function"
|
|
name: "functionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract Mono<Map<String,String>> listFunctionKeysAsync(String functionName)"
|
|
desc: "Retrieve the function key for a specific function."
|
|
returns:
|
|
description: "the function key"
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>>"
|
|
- uid: "com.azure.resourcemanager.appservice.models.FunctionApp.listFunctions()"
|
|
fullName: "com.azure.resourcemanager.appservice.models.FunctionApp.listFunctions()"
|
|
name: "listFunctions()"
|
|
nameWithType: "FunctionApp.listFunctions()"
|
|
summary: "List function information elements."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract PagedIterable<FunctionEnvelope> listFunctions()"
|
|
desc: "List function information elements."
|
|
returns:
|
|
description: "list of function information elements"
|
|
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.appservice.models.FunctionEnvelope?alt=com.azure.resourcemanager.appservice.models.FunctionEnvelope&text=FunctionEnvelope\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.appservice.models.FunctionApp.managedEnvironmentId()"
|
|
fullName: "com.azure.resourcemanager.appservice.models.FunctionApp.managedEnvironmentId()"
|
|
name: "managedEnvironmentId()"
|
|
nameWithType: "FunctionApp.managedEnvironmentId()"
|
|
summary: "Retrieve the ID of the Azure Container Apps environment that the Function App runs on."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract String managedEnvironmentId()"
|
|
desc: "Retrieve the ID of the Azure Container Apps environment that the Function App runs on."
|
|
returns:
|
|
description: "the ID of the Azure Container Apps environment"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.appservice.models.FunctionApp.maxReplicas()"
|
|
fullName: "com.azure.resourcemanager.appservice.models.FunctionApp.maxReplicas()"
|
|
name: "maxReplicas()"
|
|
nameWithType: "FunctionApp.maxReplicas()"
|
|
summary: "Retrieves the maximum replica count."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Integer maxReplicas()"
|
|
desc: "Retrieves the maximum replica count."
|
|
returns:
|
|
description: "the maximum replica count"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.resourcemanager.appservice.models.FunctionApp.minReplicas()"
|
|
fullName: "com.azure.resourcemanager.appservice.models.FunctionApp.minReplicas()"
|
|
name: "minReplicas()"
|
|
nameWithType: "FunctionApp.minReplicas()"
|
|
summary: "Retrieves the minimum replica count."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Integer minReplicas()"
|
|
desc: "Retrieves the minimum replica count."
|
|
returns:
|
|
description: "the minimum replica count"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.resourcemanager.appservice.models.FunctionApp.removeFunctionKey(java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.appservice.models.FunctionApp.removeFunctionKey(String functionName, String keyName)"
|
|
name: "removeFunctionKey(String functionName, String keyName)"
|
|
nameWithType: "FunctionApp.removeFunctionKey(String functionName, String keyName)"
|
|
summary: "Removes a key to a function in this function app."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the name of the function"
|
|
name: "functionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "the name of the key to remove"
|
|
name: "keyName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract void removeFunctionKey(String functionName, String keyName)"
|
|
desc: "Removes a key to a function in this function app."
|
|
- uid: "com.azure.resourcemanager.appservice.models.FunctionApp.removeFunctionKeyAsync(java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.appservice.models.FunctionApp.removeFunctionKeyAsync(String functionName, String keyName)"
|
|
name: "removeFunctionKeyAsync(String functionName, String keyName)"
|
|
nameWithType: "FunctionApp.removeFunctionKeyAsync(String functionName, String keyName)"
|
|
summary: "Removes a key to a function in this function app."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the name of the function"
|
|
name: "functionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "the name of the key to remove"
|
|
name: "keyName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract Mono<Void> removeFunctionKeyAsync(String functionName, String keyName)"
|
|
desc: "Removes a key to a function in this function app."
|
|
returns:
|
|
description: "the completable of the operation"
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.resourcemanager.appservice.models.FunctionApp.storageAccount()"
|
|
fullName: "com.azure.resourcemanager.appservice.models.FunctionApp.storageAccount()"
|
|
name: "storageAccount()"
|
|
nameWithType: "FunctionApp.storageAccount()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract StorageAccount storageAccount()"
|
|
returns:
|
|
description: "the storage account associated with the function app"
|
|
type: "<xref href=\"com.azure.resourcemanager.storage.models.StorageAccount?alt=com.azure.resourcemanager.storage.models.StorageAccount&text=StorageAccount\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.appservice.models.FunctionApp.syncTriggers()"
|
|
fullName: "com.azure.resourcemanager.appservice.models.FunctionApp.syncTriggers()"
|
|
name: "syncTriggers()"
|
|
nameWithType: "FunctionApp.syncTriggers()"
|
|
summary: "Syncs the triggers on the function app."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract void syncTriggers()"
|
|
desc: "Syncs the triggers on the function app."
|
|
- uid: "com.azure.resourcemanager.appservice.models.FunctionApp.syncTriggersAsync()"
|
|
fullName: "com.azure.resourcemanager.appservice.models.FunctionApp.syncTriggersAsync()"
|
|
name: "syncTriggersAsync()"
|
|
nameWithType: "FunctionApp.syncTriggersAsync()"
|
|
summary: "Syncs the triggers on the function app."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Mono<Void> syncTriggersAsync()"
|
|
desc: "Syncs the triggers on the function app."
|
|
returns:
|
|
description: "a completable for the operation"
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.resourcemanager.appservice.models.FunctionApp.triggerFunction(java.lang.String,java.lang.Object)"
|
|
fullName: "com.azure.resourcemanager.appservice.models.FunctionApp.triggerFunction(String functionName, Object payload)"
|
|
name: "triggerFunction(String functionName, Object payload)"
|
|
nameWithType: "FunctionApp.triggerFunction(String functionName, Object payload)"
|
|
summary: "Triggers a function."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the name of the function"
|
|
name: "functionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "the payload to be serialized to JSON"
|
|
name: "payload"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
syntax: "public abstract void triggerFunction(String functionName, Object payload)"
|
|
desc: "Triggers a function."
|
|
- uid: "com.azure.resourcemanager.appservice.models.FunctionApp.triggerFunctionAsync(java.lang.String,java.lang.Object)"
|
|
fullName: "com.azure.resourcemanager.appservice.models.FunctionApp.triggerFunctionAsync(String functionName, Object payload)"
|
|
name: "triggerFunctionAsync(String functionName, Object payload)"
|
|
nameWithType: "FunctionApp.triggerFunctionAsync(String functionName, Object payload)"
|
|
summary: "Triggers a function."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the name of the function"
|
|
name: "functionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "the payload to be serialized to JSON"
|
|
name: "payload"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
syntax: "public abstract Mono<Void> triggerFunctionAsync(String functionName, Object payload)"
|
|
desc: "Triggers a function."
|
|
returns:
|
|
description: "the completable of the operation"
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
type: "interface"
|
|
desc: "An immutable client-side representation of an Azure Function App."
|
|
implements:
|
|
- "<xref href=\"com.azure.resourcemanager.appservice.models.FunctionAppBasic?alt=com.azure.resourcemanager.appservice.models.FunctionAppBasic&text=FunctionAppBasic\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.resourcemanager.appservice.models.WebAppBase?alt=com.azure.resourcemanager.appservice.models.WebAppBase&text=WebAppBase\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateEndpointConnection?alt=com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateEndpointConnection&text=SupportsListingPrivateEndpointConnection\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateLinkResource?alt=com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateLinkResource&text=SupportsListingPrivateLinkResource\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.collection.SupportsUpdatingPrivateEndpointConnection?alt=com.azure.resourcemanager.resources.fluentcore.collection.SupportsUpdatingPrivateEndpointConnection&text=SupportsUpdatingPrivateEndpointConnection\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.model.Updatable?alt=com.azure.resourcemanager.resources.fluentcore.model.Updatable&text=Updatable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.appservice.models.FunctionApp.Update?alt=com.azure.resourcemanager.appservice.models.FunctionApp.Update&text=Update\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.appservice.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-appservice:2.42.0
|