@datafire/azure_servicefabricmesh
Client library for SeaBreezeManagementClient
Installation and Usage
npm install --save @datafire/azure_servicefabricmesh
let azure_servicefabricmesh = require('@datafire/azure_servicefabricmesh').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
APIs to deploy and manage resources to SeaBreeze.
Actions
Operations_List
Lists all the available operations provided by Service Fabric SeaBreeze resource provider.
azure_servicefabricmesh.Operations_List({
"api-version": ""
}, context)
Input
- input
object
- api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
.
- api-version required
Output
- output OperationListResult
Application_ListBySubscription
Gets the information about all application resources in a given resource group. The information include the description and other properties of the application.
azure_servicefabricmesh.Application_ListBySubscription({
"subscriptionId": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
.
- subscriptionId required
Output
Gateway_ListBySubscription
Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the gateway.
azure_servicefabricmesh.Gateway_ListBySubscription({
"subscriptionId": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
.
- subscriptionId required
Output
Network_ListBySubscription
Gets the information about all network resources in a given resource group. The information include the description and other properties of the network.
azure_servicefabricmesh.Network_ListBySubscription({
"subscriptionId": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
.
- subscriptionId required
Output
Secret_ListBySubscription
Gets the information about all secret resources in a given resource group. The information include the description and other properties of the secret.
azure_servicefabricmesh.Secret_ListBySubscription({
"subscriptionId": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
.
- subscriptionId required
Output
Volume_ListBySubscription
Gets the information about all volume resources in a given resource group. The information include the description and other properties of the volume.
azure_servicefabricmesh.Volume_ListBySubscription({
"subscriptionId": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
.
- subscriptionId required
Output
Application_ListByResourceGroup
Gets the information about all application resources in a given resource group. The information include the description and other properties of the Application.
azure_servicefabricmesh.Application_ListByResourceGroup({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name
- subscriptionId required
Output
Application_Delete
Deletes the application resource identified by the name.
azure_servicefabricmesh.Application_Delete({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": "",
"applicationResourceName": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name - applicationResourceName required
string
: The identity of the application.
- subscriptionId required
Output
Output schema unknown
Application_Get
Gets the information about the application resource with the given name. The information include the description and other properties of the application.
azure_servicefabricmesh.Application_Get({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": "",
"applicationResourceName": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name - applicationResourceName required
string
: The identity of the application.
- subscriptionId required
Output
Application_Create
Creates an application resource with the specified name, description and properties. If an application resource with the same name exists, then it is updated with the specified description and properties.
azure_servicefabricmesh.Application_Create({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": "",
"applicationResourceName": "",
"applicationResourceDescription": null
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name - applicationResourceName required
string
: The identity of the application. - applicationResourceDescription required ApplicationResourceDescription
- subscriptionId required
Output
Service_List
Gets the information about all services of an application resource. The information include the description and other properties of the Service.
azure_servicefabricmesh.Service_List({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": "",
"applicationResourceName": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name - applicationResourceName required
string
: The identity of the application.
- subscriptionId required
Output
Service_Get
Gets the information about the service resource with the given name. The information include the description and other properties of the service.
azure_servicefabricmesh.Service_Get({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": "",
"applicationResourceName": "",
"serviceResourceName": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name - applicationResourceName required
string
: The identity of the application. - serviceResourceName required
string
: The identity of the service.
- subscriptionId required
Output
- output ServiceResourceDescription
ServiceReplica_List
Gets the information about all replicas of a given service of an application. The information includes the runtime properties of the replica instance.
azure_servicefabricmesh.ServiceReplica_List({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": "",
"applicationResourceName": "",
"serviceResourceName": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name - applicationResourceName required
string
: The identity of the application. - serviceResourceName required
string
: The identity of the service.
- subscriptionId required
Output
ServiceReplica_Get
Gets the information about the service replica with the given name. The information include the description and other properties of the service replica.
azure_servicefabricmesh.ServiceReplica_Get({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": "",
"applicationResourceName": "",
"serviceResourceName": "",
"replicaName": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name - applicationResourceName required
string
: The identity of the application. - serviceResourceName required
string
: The identity of the service. - replicaName required
string
: Service Fabric replica name.
- subscriptionId required
Output
- output ServiceReplicaDescription
CodePackage_GetContainerLogs
Gets the logs for the container of the specified code package of the service replica.
azure_servicefabricmesh.CodePackage_GetContainerLogs({
"subscriptionId": "",
"resourceGroupName": "",
"api-version": "",
"applicationResourceName": "",
"serviceResourceName": "",
"replicaName": "",
"codePackageName": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - resourceGroupName required
string
: Azure resource group name - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - applicationResourceName required
string
: The identity of the application. - serviceResourceName required
string
: The identity of the service. - replicaName required
string
: Service Fabric replica name. - codePackageName required
string
: The name of code package of the service. - tail
integer
: Number of lines to show from the end of the logs. Default is 100.
- subscriptionId required
Output
- output ContainerLogs
Gateway_ListByResourceGroup
Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the Gateway.
azure_servicefabricmesh.Gateway_ListByResourceGroup({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name
- subscriptionId required
Output
Gateway_Delete
Deletes the gateway resource identified by the name.
azure_servicefabricmesh.Gateway_Delete({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": "",
"gatewayResourceName": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name - gatewayResourceName required
string
: The identity of the gateway.
- subscriptionId required
Output
Output schema unknown
Gateway_Get
Gets the information about the gateway resource with the given name. The information include the description and other properties of the gateway.
azure_servicefabricmesh.Gateway_Get({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": "",
"gatewayResourceName": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name - gatewayResourceName required
string
: The identity of the gateway.
- subscriptionId required
Output
- output GatewayResourceDescription
Gateway_Create
Creates a gateway resource with the specified name, description and properties. If a gateway resource with the same name exists, then it is updated with the specified description and properties. Use gateway resources to create a gateway for public connectivity for services within your application.
azure_servicefabricmesh.Gateway_Create({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": "",
"gatewayResourceName": "",
"gatewayResourceDescription": null
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name - gatewayResourceName required
string
: The identity of the gateway. - gatewayResourceDescription required GatewayResourceDescription
- subscriptionId required
Output
- output GatewayResourceDescription
Network_ListByResourceGroup
Gets the information about all network resources in a given resource group. The information include the description and other properties of the Network.
azure_servicefabricmesh.Network_ListByResourceGroup({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name
- subscriptionId required
Output
Network_Delete
Deletes the network resource identified by the name.
azure_servicefabricmesh.Network_Delete({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": "",
"networkResourceName": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name - networkResourceName required
string
: The identity of the network.
- subscriptionId required
Output
Output schema unknown
Network_Get
Gets the information about the network resource with the given name. The information include the description and other properties of the network.
azure_servicefabricmesh.Network_Get({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": "",
"networkResourceName": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name - networkResourceName required
string
: The identity of the network.
- subscriptionId required
Output
- output NetworkResourceDescription
Network_Create
Creates a network resource with the specified name, description and properties. If a network resource with the same name exists, then it is updated with the specified description and properties.
azure_servicefabricmesh.Network_Create({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": "",
"networkResourceName": "",
"networkResourceDescription": null
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name - networkResourceName required
string
: The identity of the network. - networkResourceDescription required NetworkResourceDescription
- subscriptionId required
Output
- output NetworkResourceDescription
Secret_ListByResourceGroup
Gets the information about all secret resources in a given resource group. The information include the description and other properties of the Secret.
azure_servicefabricmesh.Secret_ListByResourceGroup({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name
- subscriptionId required
Output
Secret_Delete
Deletes the secret resource identified by the name.
azure_servicefabricmesh.Secret_Delete({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": "",
"secretResourceName": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name - secretResourceName required
string
: The name of the secret resource.
- subscriptionId required
Output
Output schema unknown
Secret_Get
Gets the information about the secret resource with the given name. The information include the description and other properties of the secret.
azure_servicefabricmesh.Secret_Get({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": "",
"secretResourceName": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name - secretResourceName required
string
: The name of the secret resource.
- subscriptionId required
Output
- output SecretResourceDescription
Secret_Create
Creates a secret resource with the specified name, description and properties. If a secret resource with the same name exists, then it is updated with the specified description and properties.
azure_servicefabricmesh.Secret_Create({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": "",
"secretResourceName": "",
"secretResourceDescription": null
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name - secretResourceName required
string
: The name of the secret resource. - secretResourceDescription required SecretResourceDescription
- subscriptionId required
Output
- output SecretResourceDescription
SecretValue_List
Gets information about all secret value resources of the specified secret resource. The information includes the names of the secret value resources, but not the actual values.
azure_servicefabricmesh.SecretValue_List({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": "",
"secretResourceName": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name - secretResourceName required
string
: The name of the secret resource.
- subscriptionId required
Output
SecretValue_Delete
Deletes the secret value resource identified by the name. The name of the resource is typically the version associated with that value. Deletion will fail if the specified value is in use.
azure_servicefabricmesh.SecretValue_Delete({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": "",
"secretResourceName": "",
"secretValueResourceName": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name - secretResourceName required
string
: The name of the secret resource. - secretValueResourceName required
string
: The name of the secret resource value which is typically the version identifier for the value.
- subscriptionId required
Output
Output schema unknown
SecretValue_Get
Get the information about the specified named secret value resources. The information does not include the actual value of the secret.
azure_servicefabricmesh.SecretValue_Get({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": "",
"secretResourceName": "",
"secretValueResourceName": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name - secretResourceName required
string
: The name of the secret resource. - secretValueResourceName required
string
: The name of the secret resource value which is typically the version identifier for the value.
- subscriptionId required
Output
SecretValue_Create
Creates a new value of the specified secret resource. The name of the value is typically the version identifier. Once created the value cannot be changed.
azure_servicefabricmesh.SecretValue_Create({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": "",
"secretResourceName": "",
"secretValueResourceName": "",
"secretValueResourceDescription": null
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name - secretResourceName required
string
: The name of the secret resource. - secretValueResourceName required
string
: The name of the secret resource value which is typically the version identifier for the value. - secretValueResourceDescription required SecretValueResourceDescription
- subscriptionId required
Output
SecretValue_ListValue
Lists the decrypted value of the specified named value of the secret resource. This is a privileged operation.
azure_servicefabricmesh.SecretValue_ListValue({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": "",
"secretResourceName": "",
"secretValueResourceName": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name - secretResourceName required
string
: The name of the secret resource. - secretValueResourceName required
string
: The name of the secret resource value which is typically the version identifier for the value.
- subscriptionId required
Output
- output SecretValue
Volume_ListByResourceGroup
Gets the information about all volume resources in a given resource group. The information include the description and other properties of the Volume.
azure_servicefabricmesh.Volume_ListByResourceGroup({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name
- subscriptionId required
Output
Volume_Delete
Deletes the volume resource identified by the name.
azure_servicefabricmesh.Volume_Delete({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": "",
"volumeResourceName": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name - volumeResourceName required
string
: The identity of the volume.
- subscriptionId required
Output
Output schema unknown
Volume_Get
Gets the information about the volume resource with the given name. The information include the description and other properties of the volume.
azure_servicefabricmesh.Volume_Get({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": "",
"volumeResourceName": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name - volumeResourceName required
string
: The identity of the volume.
- subscriptionId required
Output
- output VolumeResourceDescription
Volume_Create
Creates a volume resource with the specified name, description and properties. If a volume resource with the same name exists, then it is updated with the specified description and properties.
azure_servicefabricmesh.Volume_Create({
"subscriptionId": "",
"api-version": "",
"resourceGroupName": "",
"volumeResourceName": "",
"volumeResourceDescription": null
}, context)
Input
- input
object
- subscriptionId required
string
: The customer subscription identifier - api-version required
string
(values: 2018-09-01-preview): The version of the API. This parameter is required and its value must be2018-09-01-preview
. - resourceGroupName required
string
: Azure resource group name - volumeResourceName required
string
: The identity of the volume. - volumeResourceDescription required VolumeResourceDescription
- subscriptionId required
Output
- output VolumeResourceDescription
Definitions
AddRemoveReplicaScalingMechanism
- AddRemoveReplicaScalingMechanism
object
: Describes the horizontal auto scaling mechanism that adds or removes replicas (containers or container groups).- maxCount required
integer
: Maximum number of containers (scale up won't be performed above this number). - minCount required
integer
: Minimum number of containers (scale down won't be performed below this number). - scaleIncrement required
integer
: Each time auto scaling is performed, this number of containers will be added or removed. - kind required AutoScalingMechanismKind
- maxCount required
ApplicationProperties
- ApplicationProperties
object
: Describes properties of a application resource.- debugParams
string
: Internal - used by Visual Studio to setup the debugging session on the local development environment. - description
string
: User readable description of the application. - diagnostics DiagnosticsDescription
- healthState HealthState
- serviceNames
array
: Names of the services in the application.- items
string
- items
- services
array
: Describes the services in the application. This property is used to create or modify services of the application. On get only the name of the service is returned. The service description can be obtained by querying for the service resource. - status ResourceStatus
- statusDetails
string
: Gives additional information about the current status of the application. - unhealthyEvaluation
string
: When the application's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the application is marked unhealthy.
- debugParams
ApplicationResourceDescription
- ApplicationResourceDescription
object
: This type describes an application resource.- properties required ApplicationResourceProperties
- location required
string
: The geo-location where the resource lives - tags
object
: Resource tags. - id
string
: Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - name
string
: The name of the resource - type
string
: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
ApplicationResourceDescriptionList
- ApplicationResourceDescriptionList
object
: A pageable list of application resources.- nextLink
string
: URI to fetch the next page of the list. - value
array
: One page of the list.
- nextLink
ApplicationResourceProperties
- ApplicationResourceProperties: This type describes properties of an application resource.
- provisioningState
string
: State of the resource. - debugParams
string
: Internal - used by Visual Studio to setup the debugging session on the local development environment. - description
string
: User readable description of the application. - diagnostics DiagnosticsDescription
- healthState HealthState
- serviceNames
array
: Names of the services in the application.- items
string
- items
- services
array
: Describes the services in the application. This property is used to create or modify services of the application. On get only the name of the service is returned. The service description can be obtained by querying for the service resource. - status ResourceStatus
- statusDetails
string
: Gives additional information about the current status of the application. - unhealthyEvaluation
string
: When the application's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the application is marked unhealthy.
- provisioningState
ApplicationScopedVolume
- ApplicationScopedVolume
object
: Describes a volume whose lifetime is scoped to the application's lifetime.- creationParameters required ApplicationScopedVolumeCreationParameters
- destinationPath required
string
: The path within the container at which the volume should be mounted. Only valid path characters are allowed. - name required
string
: Name of the volume being referenced. - readOnly
boolean
: The flag indicating whether the volume is read only. Default is 'false'.
ApplicationScopedVolumeCreationParameters
- ApplicationScopedVolumeCreationParameters
object
: Describes parameters for creating application-scoped volumes.- description
string
: User readable description of the volume. - kind required ApplicationScopedVolumeKind
- description
ApplicationScopedVolumeCreationParametersServiceFabricVolumeDisk
- ApplicationScopedVolumeCreationParametersServiceFabricVolumeDisk
object
: Describes parameters for creating application-scoped volumes provided by Service Fabric Volume Disks- sizeDisk required
string
(values: Small, Medium, Large): Volume size - description
string
: User readable description of the volume. - kind required ApplicationScopedVolumeKind
- sizeDisk required
ApplicationScopedVolumeKind
- ApplicationScopedVolumeKind
string
(values: ServiceFabricVolumeDisk): Specifies the application-scoped volume kind.
AutoScalingMechanism
- AutoScalingMechanism
object
: Describes the mechanism for performing auto scaling operation. Derived classes will describe the actual mechanism.- kind required AutoScalingMechanismKind
AutoScalingMechanismKind
- AutoScalingMechanismKind
string
(values: AddRemoveReplica): Enumerates the mechanisms for auto scaling.
AutoScalingMetric
- AutoScalingMetric
object
: Describes the metric that is used for triggering auto scaling operation. Derived classes will describe resources or metrics.- kind required AutoScalingMetricKind
AutoScalingMetricKind
- AutoScalingMetricKind
string
(values: Resource): Enumerates the metrics that are used for triggering auto scaling.
AutoScalingPolicy
- AutoScalingPolicy
object
: Describes the auto scaling policy- mechanism required AutoScalingMechanism
- name required
string
: The name of the auto scaling policy. - trigger required AutoScalingTrigger
AutoScalingResourceMetric
- AutoScalingResourceMetric
object
: Describes the resource that is used for triggering auto scaling.- name required AutoScalingResourceMetricName
- kind required AutoScalingMetricKind
AutoScalingResourceMetricName
- AutoScalingResourceMetricName
string
(values: cpu, memoryInGB): Enumerates the resources that are used for triggering auto scaling.
AutoScalingTrigger
- AutoScalingTrigger
object
: Describes the trigger for performing auto scaling operation.- kind required AutoScalingTriggerKind
AutoScalingTriggerKind
- AutoScalingTriggerKind
string
(values: AverageLoad): Enumerates the triggers for auto scaling.
AvailableOperationDisplay
- AvailableOperationDisplay
object
: An operation available at the listed Azure resource provider.- description
string
: Description of the available operation. - operation
string
: Name of the available operation. - provider
string
: Name of the operation provider. - resource
string
: Name of the resource on which the operation is available.
- description
AverageLoadScalingTrigger
- AverageLoadScalingTrigger
object
: Describes the average load trigger used for auto scaling.- lowerLoadThreshold required
number
: Lower load threshold (if average load is below this threshold, service will scale down). - metric required AutoScalingMetric
- scaleIntervalInSeconds required
integer
: Scale interval that indicates how often will this trigger be checked. - upperLoadThreshold required
number
: Upper load threshold (if average load is above this threshold, service will scale up). - kind required AutoScalingTriggerKind
- lowerLoadThreshold required
AzureInternalMonitoringPipelineSinkDescription
- AzureInternalMonitoringPipelineSinkDescription
object
: Diagnostics settings for Geneva.- accountName
string
: Azure Internal monitoring pipeline account. - autoKeyConfigUrl
string
: Azure Internal monitoring pipeline autokey associated with the certificate. - maConfigUrl
string
: Azure Internal monitoring agent configuration. - namespace
string
: Azure Internal monitoring pipeline account namespace. - description
string
: A description of the sink. - kind required DiagnosticsSinkKind
- name
string
: Name of the sink. This value is referenced by DiagnosticsReferenceDescription
- accountName
ContainerCodePackageProperties
- ContainerCodePackageProperties
object
: Describes a container and its runtime properties.- commands
array
: Command array to execute within the container in exec form.- items
string
- items
- diagnostics DiagnosticsRef
- endpoints
array
: The endpoints exposed by this container.- items EndpointProperties
- entrypoint
string
: Override for the default entry point in the container. - environmentVariables
array
: The environment variables to set in this container- items EnvironmentVariable
- image required
string
: The Container image to use. - imageRegistryCredential ImageRegistryCredential
- instanceView ContainerInstanceView
- labels
array
: The labels to set in this container.- items ContainerLabel
- name required
string
: The name of the code package. - reliableCollectionsRefs
array
: A list of ReliableCollection resources used by this particular code package. Please refer to ReliableCollectionsRef for more details.- items ReliableCollectionsRef
- resources required ResourceRequirements
- settings
array
: The settings to set in this container. The setting file path can be fetched from environment variable "Fabric_SettingPath". The path for Windows container is "C:\secrets". The path for Linux container is "/var/secrets".- items Setting
- volumeRefs
array
: Volumes to be attached to the container. The lifetime of these volumes is independent of the application's lifetime.- items VolumeReference
- volumes
array
: Volumes to be attached to the container. The lifetime of these volumes is scoped to the application's lifetime.- items ApplicationScopedVolume
- commands
ContainerEvent
- ContainerEvent
object
: A container event.- count
integer
: The count of the event. - firstTimestamp
string
: Date/time of the first event. - lastTimestamp
string
: Date/time of the last event. - message
string
: The event message - name
string
: The name of the container event. - type
string
: The event type.
- count
ContainerInstanceView
- ContainerInstanceView
object
: Runtime information of a container instance.- currentState ContainerState
- events
array
: The events of this container instance.- items ContainerEvent
- previousState ContainerState
- restartCount
integer
: The number of times the container has been restarted.
ContainerLabel
- ContainerLabel
object
: Describes a container label.- name required
string
: The name of the container label. - value required
string
: The value of the container label.
- name required
ContainerLogs
- ContainerLogs
object
: Container logs.- content
string
: Container logs.
- content
ContainerState
- ContainerState
object
: The container state.- detailStatus
string
: Human-readable status of this state. - exitCode
string
: The container exit code. - finishTime
string
: Date/time when the container state finished. - startTime
string
: Date/time when the container state started. - state
string
: The state of this container
- detailStatus
DiagnosticsDescription
- DiagnosticsDescription
object
: Describes the diagnostics options available- defaultSinkRefs
array
: The sinks to be used if diagnostics is enabled. Sink choices can be overridden at the service and code package level.- items
string
- items
- enabled
boolean
: Status of whether or not sinks are enabled. - sinks
array
: List of supported sinks that can be referenced.
- defaultSinkRefs
DiagnosticsRef
- DiagnosticsRef
object
: Reference to sinks in DiagnosticsDescription.- enabled
boolean
: Status of whether or not sinks are enabled. - sinkRefs
array
: List of sinks to be used if enabled. References the list of sinks in DiagnosticsDescription.- items
string
- items
- enabled
DiagnosticsSinkKind
- DiagnosticsSinkKind
string
(values: Invalid, AzureInternalMonitoringPipeline): The kind of DiagnosticsSink.
DiagnosticsSinkProperties
- DiagnosticsSinkProperties
object
: Properties of a DiagnosticsSink.- description
string
: A description of the sink. - kind required DiagnosticsSinkKind
- name
string
: Name of the sink. This value is referenced by DiagnosticsReferenceDescription
- description
EndpointProperties
- EndpointProperties
object
: Describes a container endpoint.- name required
string
: The name of the endpoint. - port
integer
: Port used by the container.
- name required
EndpointRef
- EndpointRef
object
: Describes a reference to a service endpoint.- name
string
: Name of the endpoint.
- name
EnvironmentVariable
- EnvironmentVariable
object
: Describes an environment variable for the container.- name
string
: The name of the environment variable. - value
string
: The value of the environment variable.
- name
ErrorDetailsModel
- ErrorDetailsModel
object
: Error model details information- code required
string
- message required
string
: Error message.
- code required
ErrorErrorModel
- ErrorErrorModel
object
: Error model information- code required
string
- details
array
: List of error message details.- items ErrorDetailsModel
- innerError
string
- message
string
: Error message.
- code required
ErrorModel
- ErrorModel
object
: The error details.- error required ErrorErrorModel
GatewayDestination
- GatewayDestination
object
: Describes destination endpoint for routing traffic.- applicationName required
string
: Name of the service fabric Mesh application. - endpointName required
string
: name of the endpoint in the service. - serviceName required
string
: service that contains the endpoint.
- applicationName required
GatewayProperties
- GatewayProperties
object
: Describes properties of a gateway resource.- description
string
: User readable description of the gateway. - destinationNetwork required NetworkRef
- http
array
: Configuration for http connectivity for this gateway.- items HttpConfig
- ipAddress
string
: IP address of the gateway. This is populated in the response and is ignored for incoming requests. - sourceNetwork required NetworkRef
- status ResourceStatus
- statusDetails
string
: Gives additional information about the current status of the gateway. - tcp
array
: Configuration for tcp connectivity for this gateway.- items TcpConfig
- description
GatewayResourceDescription
- GatewayResourceDescription
object
: This type describes a gateway resource.- properties required GatewayResourceProperties
- location required
string
: The geo-location where the resource lives - tags
object
: Resource tags. - id
string
: Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - name
string
: The name of the resource - type
string
: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
GatewayResourceDescriptionList
- GatewayResourceDescriptionList
object
: A pageable list of gateway resources.- nextLink
string
: URI to fetch the next page of the list. - value
array
: One page of the list.
- nextLink
GatewayResourceProperties
- GatewayResourceProperties: This type describes properties of a gateway resource.
- provisioningState
string
: State of the resource. - description
string
: User readable description of the gateway. - destinationNetwork required NetworkRef
- http
array
: Configuration for http connectivity for this gateway.- items HttpConfig
- ipAddress
string
: IP address of the gateway. This is populated in the response and is ignored for incoming requests. - sourceNetwork required NetworkRef
- status ResourceStatus
- statusDetails
string
: Gives additional information about the current status of the gateway. - tcp
array
: Configuration for tcp connectivity for this gateway.- items TcpConfig
- provisioningState
HealthState
- HealthState
string
(values: Invalid, Ok, Warning, Error, Unknown): The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
HttpConfig
- HttpConfig
object
: Describes the http configuration for external connectivity for this network.- hosts required
array
: description for routing.- items HttpHostConfig
- name required
string
: http gateway config name. - port required
integer
: Specifies the port at which the service endpoint below needs to be exposed.
- hosts required
HttpHostConfig
- HttpHostConfig
object
: Describes the hostname properties for http routing.- name required
string
: http hostname config name. - routes required
array
: Route information to use for routing. Routes are processed in the order they are specified. Specify routes that are more specific before routes that can handle general cases.- items HttpRouteConfig
- name required
HttpRouteConfig
- HttpRouteConfig
object
: Describes the hostname properties for http routing.- destination required GatewayDestination
- match required HttpRouteMatchRule
- name required
string
: http route name.
HttpRouteMatchHeader
- HttpRouteMatchHeader
object
: Describes header information for http route matching.- name required
string
: Name of header to match in request. - type
string
(values: exact): how to match header value - value
string
: Value of header to match in request.
- name required
HttpRouteMatchPath
- HttpRouteMatchPath
object
: Path to match for routing.- rewrite
string
: replacement string for matched part of the Uri. - type required
string
(values: prefix): how to match value in the Uri - value required
string
: Uri path to match for request.
- rewrite
HttpRouteMatchRule
- HttpRouteMatchRule
object
: Describes a rule for http route matching.- headers
array
: headers and their values to match in request.- items HttpRouteMatchHeader
- path required HttpRouteMatchPath
- headers
ImageRegistryCredential
- ImageRegistryCredential
object
: Image registry credential.- password
string
: The password for the private registry. The password is required for create or update operations, however it is not returned in the get or list operations. - server required
string
: Docker image registry server, without protocol such ashttp
andhttps
. - username required
string
: The username for the private registry.
- password
InlinedValueSecretResourceProperties
- InlinedValueSecretResourceProperties: Describes the properties of a secret resource whose value is provided explicitly as plaintext. The secret resource may have multiple values, each being uniquely versioned. The secret value of each version is stored encrypted, and delivered as plaintext into the context of applications referencing it.
- contentType
string
: The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed. - description
string
: User readable description of the secret. - status ResourceStatus
- statusDetails
string
: Gives additional information about the current status of the secret. - kind required SecretKind
- provisioningState
string
: State of the resource.
- contentType
LocalNetworkResourceProperties
- LocalNetworkResourceProperties
object
: Information about a Service Fabric container network local to a single Service Fabric cluster.- networkAddressPrefix NetworkAddressPrefix
- description
string
: User readable description of the network. - status ResourceStatus
- statusDetails
string
: Gives additional information about the current status of the network. - kind required NetworkKind
- provisioningState
string
: State of the resource.
ManagedProxyResource
- ManagedProxyResource
object
: The resource model definition for Azure Resource Manager proxy resource. It will have everything other than required location and tags. This proxy resource is explicitly created or updated by including it in the parent resource.- id
string
: Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - name
string
: The name of the resource - type
string
: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
- id
NetworkAddressPrefix
- NetworkAddressPrefix
string
: Address space for a container network. This is expressed in CIDR notation.
NetworkKind
- NetworkKind
string
(values: Local): The type of a Service Fabric container network.
NetworkRef
- NetworkRef
object
: Describes a network reference in a service.- endpointRefs
array
: A list of endpoints that are exposed on this network.- items EndpointRef
- name
string
: Name of the network
- endpointRefs
NetworkResourceDescription
- NetworkResourceDescription
object
: This type describes a network resource.- properties required NetworkResourceProperties
- location required
string
: The geo-location where the resource lives - tags
object
: Resource tags. - id
string
: Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - name
string
: The name of the resource - type
string
: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
NetworkResourceDescriptionList
- NetworkResourceDescriptionList
object
: A pageable list of network resources.- nextLink
string
: URI to fetch the next page of the list. - value
array
: One page of the list.
- nextLink
NetworkResourceProperties
- NetworkResourceProperties
object
: Describes properties of a network resource.- description
string
: User readable description of the network. - status ResourceStatus
- statusDetails
string
: Gives additional information about the current status of the network. - kind required NetworkKind
- provisioningState
string
: State of the resource.
- description
NetworkResourcePropertiesBase
- NetworkResourcePropertiesBase
object
: This type describes the properties of a network resource, including its kind.- kind required NetworkKind
- provisioningState
string
: State of the resource.
OperatingSystemType
- OperatingSystemType
string
(values: Linux, Windows): The operation system required by the code in service.
OperationListResult
- OperationListResult
object
: Describes the result of the request to list Service Fabric operations.- nextLink
string
: URL to get the next set of operation list results if there are any. - value
array
: List of Service Fabric operations supported by the Microsoft.ServiceFabric resource provider.- items OperationResult
- nextLink
OperationResult
- OperationResult
object
: List of operations available at the listed Azure resource provider.- display AvailableOperationDisplay
- name
string
: The name of the operation. - nextLink
string
: The URL to use for getting the next set of results. - origin
string
: Origin result
ProvisionedResourceProperties
- ProvisionedResourceProperties
object
: Describes common properties of a provisioned resource.- provisioningState
string
: State of the resource.
- provisioningState
ProxyResource
- ProxyResource: The resource model definition for Azure Resource Manager proxy resource. It will have everything other than required location and tags.
- id
string
: Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - name
string
: The name of the resource - type
string
: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
- id
ReliableCollectionsRef
- ReliableCollectionsRef
object
: Specifying this parameter adds support for reliable collections- doNotPersistState
boolean
: False (the default) if ReliableCollections state is persisted to disk as usual. True if you do not want to persist state, in which case replication is still enabled and you can use ReliableCollections as distributed cache. - name required
string
: Name of ReliableCollection resource. Right now it's not used and you can use any string.
- doNotPersistState
Resource
- Resource
object
: The resource model definition for Azure Resource Manager resource.- id
string
: Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - name
string
: The name of the resource - type
string
: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
- id
ResourceLimits
- ResourceLimits
object
: This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted.- cpu
number
: CPU limits in cores. At present, only full cores are supported. - memoryInGB
number
: The memory limit in GB.
- cpu
ResourceRequests
- ResourceRequests
object
: This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits.- cpu required
number
: Requested number of CPU cores. At present, only full cores are supported. - memoryInGB required
number
: The memory request in GB for this container.
- cpu required
ResourceRequirements
- ResourceRequirements
object
: This type describes the resource requirements for a container or a service.- limits ResourceLimits
- requests required ResourceRequests
ResourceStatus
- ResourceStatus
string
(values: Unknown, Ready, Upgrading, Creating, Deleting, Failed): Status of the resource.
SecretKind
- SecretKind
string
(values: inlinedValue): Describes the kind of secret.
SecretResourceDescription
- SecretResourceDescription
object
: This type describes a secret resource.- properties required SecretResourceProperties
- location required
string
: The geo-location where the resource lives - tags
object
: Resource tags. - id
string
: Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - name
string
: The name of the resource - type
string
: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
SecretResourceDescriptionList
- SecretResourceDescriptionList
object
: A pageable list of secret resources.- nextLink
string
: URI to fetch the next page of the list. - value
array
: One page of the list.
- nextLink
SecretResourceProperties
- SecretResourceProperties
object
: Describes the properties of a secret resource.- contentType
string
: The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed. - description
string
: User readable description of the secret. - status ResourceStatus
- statusDetails
string
: Gives additional information about the current status of the secret. - kind required SecretKind
- provisioningState
string
: State of the resource.
- contentType
SecretResourcePropertiesBase
- SecretResourcePropertiesBase
object
: This type describes the properties of a secret resource, including its kind.- kind required SecretKind
- provisioningState
string
: State of the resource.
SecretValue
- SecretValue
object
: This type represents the unencrypted value of the secret.- value
string
: The actual value of the secret.
- value
SecretValueProperties
- SecretValueProperties
object
: This type describes properties of secret value resource.- value
string
: The actual value of the secret.
- value
SecretValueResourceDescription
- SecretValueResourceDescription
object
: This type describes a value of a secret resource. The name of this resource is the version identifier corresponding to this secret value.- properties required SecretValueResourceProperties
- location required
string
: The geo-location where the resource lives - tags
object
: Resource tags. - id
string
: Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - name
string
: The name of the resource - type
string
: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
SecretValueResourceDescriptionList
- SecretValueResourceDescriptionList
object
: A pageable list of values of a secret resource. The information does not include only the name of the value and not the actual unencrypted value.- nextLink
string
: URI to fetch the next page of the list. - value
array
: One page of the list.
- nextLink
SecretValueResourceProperties
- SecretValueResourceProperties: This type describes properties of a secret value resource.
- provisioningState
string
: State of the resource. - value
string
: The actual value of the secret.
- provisioningState
ServiceProperties
- ServiceProperties
object
: Describes properties of a service resource.- autoScalingPolicies
array
: Auto scaling policies- items AutoScalingPolicy
- description
string
: User readable description of the service. - healthState HealthState
- replicaCount
integer
: The number of replicas of the service to create. Defaults to 1 if not specified. - status ResourceStatus
- statusDetails
string
: Gives additional information about the current status of the service. - unhealthyEvaluation
string
: When the service's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the service is marked unhealthy.
- autoScalingPolicies
ServiceReplicaDescription
- ServiceReplicaDescription
object
: Describes a replica of a service resource.- replicaName required
string
: Name of the replica. - codePackages required
array
: Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.). - diagnostics DiagnosticsRef
- networkRefs
array
: The names of the private networks that this service needs to be part of.- items NetworkRef
- osType required OperatingSystemType
- replicaName required
ServiceReplicaDescriptionList
- ServiceReplicaDescriptionList
object
: A pageable list of service replicas.- nextLink
string
: URI to fetch the next page of the list. - value
array
: One page of the list.
- nextLink
ServiceReplicaProperties
- ServiceReplicaProperties
object
: Describes the properties of a service replica.- codePackages required
array
: Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.). - diagnostics DiagnosticsRef
- networkRefs
array
: The names of the private networks that this service needs to be part of.- items NetworkRef
- osType required OperatingSystemType
- codePackages required
ServiceResourceDescription
- ServiceResourceDescription
object
: This type describes a service resource.- properties required ServiceResourceProperties
- id
string
: Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - name
string
: The name of the resource - type
string
: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
ServiceResourceDescriptionList
- ServiceResourceDescriptionList
object
: A pageable list of service resources.- nextLink
string
: URI to fetch the next page of the list. - value
array
: One page of the list.
- nextLink
ServiceResourceProperties
- ServiceResourceProperties: This type describes properties of a service resource.
- provisioningState
string
: State of the resource. - codePackages required
array
: Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.). - diagnostics DiagnosticsRef
- networkRefs
array
: The names of the private networks that this service needs to be part of.- items NetworkRef
- osType required OperatingSystemType
- autoScalingPolicies
array
: Auto scaling policies- items AutoScalingPolicy
- description
string
: User readable description of the service. - healthState HealthState
- replicaCount
integer
: The number of replicas of the service to create. Defaults to 1 if not specified. - status ResourceStatus
- statusDetails
string
: Gives additional information about the current status of the service. - unhealthyEvaluation
string
: When the service's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the service is marked unhealthy.
- provisioningState
Setting
- Setting
object
: Describes a setting for the container. The setting file path can be fetched from environment variable "Fabric_SettingPath". The path for Windows container is "C:\secrets". The path for Linux container is "/var/secrets".- name
string
: The name of the setting. - value
string
: The value of the setting.
- name
TcpConfig
- TcpConfig
object
: Describes the tcp configuration for external connectivity for this network.- destination required GatewayDestination
- name required
string
: tcp gateway config name. - port required
integer
: Specifies the port at which the service endpoint below needs to be exposed.
TrackedResource
- TrackedResource
object
: The resource model definition for Azure Resource Manager tracked top-level resource.- location required
string
: The geo-location where the resource lives - tags
object
: Resource tags. - id
string
: Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - name
string
: The name of the resource - type
string
: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
- location required
VolumeProperties
- VolumeProperties
object
: Describes properties of a volume resource.- azureFileParameters VolumeProviderParametersAzureFile
- description
string
: User readable description of the volume. - provider required VolumeProvider
- status ResourceStatus
- statusDetails
string
: Gives additional information about the current status of the volume.
VolumeProvider
- VolumeProvider
string
(values: SFAzureFile): Describes the provider of the volume resource.
VolumeProviderParametersAzureFile
- VolumeProviderParametersAzureFile
object
: This type describes a volume provided by an Azure Files file share.- accountKey
string
: Access key of the Azure storage account for the File Share. - accountName required
string
: Name of the Azure storage account for the File Share. - shareName required
string
: Name of the Azure Files file share that provides storage for the volume.
- accountKey
VolumeReference
- VolumeReference
object
: Describes a reference to a volume resource.- destinationPath required
string
: The path within the container at which the volume should be mounted. Only valid path characters are allowed. - name required
string
: Name of the volume being referenced. - readOnly
boolean
: The flag indicating whether the volume is read only. Default is 'false'.
- destinationPath required
VolumeResourceDescription
- VolumeResourceDescription
object
: This type describes a volume resource.- properties required VolumeResourceProperties
- location required
string
: The geo-location where the resource lives - tags
object
: Resource tags. - id
string
: Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - name
string
: The name of the resource - type
string
: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
VolumeResourceDescriptionList
- VolumeResourceDescriptionList
object
: A pageable list of volume resources.- nextLink
string
: URI to fetch the next page of the list. - value
array
: One page of the list.
- nextLink
VolumeResourceProperties
- VolumeResourceProperties: This type describes properties of a volume resource.
- provisioningState
string
: State of the resource. - azureFileParameters VolumeProviderParametersAzureFile
- description
string
: User readable description of the volume. - provider required VolumeProvider
- status ResourceStatus
- statusDetails
string
: Gives additional information about the current status of the volume.
- provisioningState