Merge pull request #62 from dkkapur/master
bringing pp2 branch up to speed
This commit is contained in:
Deep Kapur
GitHub
Коммит
81ce1d175c
|
|
@ -31,7 +31,9 @@ Here are some of the features you can expect to evaluate and provide feedback on
|
|||
|
||||
## Private Preview 2 Capabilities
|
||||
|
||||
This released is focused on getting feedback on SeaBreeze application model (aka. Service Fabric Application Model v2). This application model is a simple, unified way of running applications on SeaBreeze and on Service Fabric clusters. It is optimized for server-less multi-tenant execution environment (aka. SeaBreeze), however supported natively in Service Fabric platform. The applications written using this model will be able to run in SeaBreeze as well as on one box development, standalone, and SFRP clusters. In private preview 2, this application model is only available on SeaBreeze platform. In future releases you will be able to build and test SeaBreeze applications on the local development cluster as well as deploy them on single tenant clusters in Azure (SFRP clusters) or on on-premise (Standalone Clusters).
|
||||
This released is focused on getting feedback on Service Fabric Applications, the new, light-weight application model for Service Fabric. Service Fabric Applications are a drastic departure from the ApplicationManifest and ServiceManifest Reliable Services XML model. With Service Fabric Applications, you no longer need to decide up front whether your service should be a Guest EXE, Guest Container, Enlighted Container, Reliable Service, etc. You simply write your application code like you normally would in any language or framework, describe how it should run in a simple YAML definition, and run it on Service Fabric.
|
||||
|
||||
Service Fabric Applications are designed around core tenants of server-less, multi-tenant execution environments like SeaBreeze while bringing simplicity overall to applications that run on Service Fabric anywhere. Service Fabric Applications will be able to run in SeaBreeze as well as on your local development environment, standalone clusters, and today's Azure clusters. Currently in private preview 2, this application model is only available in SeaBreeze.
|
||||
|
||||
## Preview Limitations
|
||||
As you are testing and providing feedback on this SeaBreeze Private Preview please be mindful of the following limitations:
|
||||
|
|
|
|||
|
|
@ -1,3 +1,19 @@
|
|||
---
|
||||
title: Frequently asked Questions and Known Issues
|
||||
description: Quick start guide on deploying Container Group Set.
|
||||
services: Azure SeaBreeze
|
||||
author: chackdan;
|
||||
manager: timlt
|
||||
|
||||
ms.service: SeaBreeze
|
||||
ms.topic: overview
|
||||
ms.assetid:
|
||||
ms.topic: article
|
||||
ms.date: 03/22/2018
|
||||
ms.author: chackdan
|
||||
ms.editor: chackdan
|
||||
---
|
||||
|
||||
# Frequently asked questions and Known Issues.
|
||||
|
||||
## Quota and Cost
|
||||
|
|
@ -26,6 +42,22 @@ The following container bases images can be used when deploying services
|
|||
|
||||
## Features Gaps and Known Issues
|
||||
|
||||
**After deploying my application, the network resource associated with it does not seem to an IP address**
|
||||
|
||||
There is a known issue today with the IP address coming up after a delay. Check the status of the network resource in a few minutes to see the associated IP address.
|
||||
|
||||
**My application is failing to access the right network/volume resource**
|
||||
|
||||
In your application model, you need to use the full resource id for networks and volumes to be able to access the associated resource. Here is what this looks like in the quickstart sample we provide:
|
||||
|
||||
```json
|
||||
"networkRefs": [
|
||||
{
|
||||
"name": "[resourceId('Microsoft.ServiceFabric/networks', 'SbzVotingNetwork')]"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
**I do not see the current application model supporting a way to encrypt my secrets**
|
||||
|
||||
Yes, this is a gap in Private Preview 2. We are working on a secret store service to help with this and expect to have this in Preview 3.
|
||||
|
|
@ -34,6 +66,7 @@ Yes, this is a gap in Private Preview 2. We are working on a secret store servic
|
|||
|
||||
If you are using older CLI version than 2.0.30, you may get this error -
|
||||
|
||||
```
|
||||
cannot import name 'sdk_no_wait'
|
||||
Traceback (most recent call last):
|
||||
File "C:\Program Files (x86)\Microsoft SDKs\Azure\CLI2\lib\site-packages\knack\cli.py", line 193, in invoke cmd_result = self.invocation.execute(args)
|
||||
|
|
@ -53,7 +86,13 @@ File "", line 205, in _call_with_frames_removed
|
|||
File "C:\Users\annayak.azure\cliextensions\azure-cli-sbz\azext_sbz\custom.py", line 18, in
|
||||
from azure.cli.core.util import get_file_json, shell_safe_json_parse, sdk_no_wait
|
||||
ImportError: cannot import name 'sdk_no_wait'.
|
||||
```
|
||||
|
||||
**I get a mismatch distribution name error when installing the CLI extension package**
|
||||
|
||||
|
||||
|
||||
This does not mean that the extension did not install. You should still be able to use the CLI commands without a problem.
|
||||
|
||||
**When I scale out, I see that all my containers are affected, including my running ones**
|
||||
|
||||
|
|
|
|||
|
|
@ -21,22 +21,22 @@ In order to deploy and manage an application, we will be using SeaBreeze CLI. Se
|
|||
|
||||
1. Login to Azure and set your subscription to the one that has been white-listed for the preview.
|
||||
|
||||
```cli
|
||||
az login
|
||||
az account set --subscription "<subscriptionName>"
|
||||
```
|
||||
```cli
|
||||
az login
|
||||
az account set --subscription "<subscriptionName>"
|
||||
```
|
||||
2. Create a resource group (RG) to deploy the application to. Alternatively, you can use an existing RG and skip this step. The preview is available only in eastus.
|
||||
|
||||
```cli
|
||||
az group create --name <resourceGroupName> --location eastus
|
||||
```
|
||||
```cli
|
||||
az group create --name <resourceGroupName> --location eastus
|
||||
```
|
||||
|
||||
3. Create your application using the following deployment command:
|
||||
|
||||
```cli
|
||||
az sbz deployment create --resource-group <resourceGroupName> --template-uri https://seabreezequickstart.blob.core.windows.net/templates/quickstart/sbz_rp.linux.json
|
||||
```cli
|
||||
az sbz deployment create --resource-group <resourceGroupName> --template-uri https://seabreezequickstart.blob.core.windows.net/templates/quickstart/sbz_rp.linux.json
|
||||
|
||||
```
|
||||
```
|
||||
In a few seconds, your command should return with "provisioningState": "Succeeded" . Given below is the output from the command when using [Cloud Shell](https://docs.microsoft.com/en-us/azure/cloud-shell/overview).
|
||||
|
||||
![AppDepl]
|
||||
|
|
|
|||
|
|
@ -1,41 +1,32 @@
|
|||
# SeaBreeze Application Model
|
||||
# Service Fabric Applications
|
||||
|
||||
## Overview
|
||||
Service Fabric Application Model v2 is a simple, unified way of running applications on SeaBreeze and on Service Fabric clusters. The model is optimized for server-less multi-tenant execution environment (aka. SeaBreeze), however supported natively in Service Fabric platform. The applications written using this model will be able to run in SeaBreeze as well as on one box development, standalone, and SFRP clusters.
|
||||
Service Fabric Applications are the new, simple way to describe and deploy applications to everywhere Service Fabric runs, whether it's SeaBreeze or your own clusters hosted in Azure, on prem, or on your laptop.
|
||||
|
||||
In summary, Service Fabric Application Model v2 is:
|
||||
- suitable for server-less, multi-tenant environment
|
||||
- a simplification of the current Service Fabric application model
|
||||
- a natural model for expressing any micro-services based applications (not just the ones that use Service Fabric's reliable service and reliable actor programming model)
|
||||
Service Fabric Applications are a drastic departure from the ApplicationManifest and ServiceManifest Reliable Services XML model. With Service Fabric Applications, you no longer need to decide up front whether your service should be a Guest EXE, Guest Container, Enlighted Container, Reliable Service, etc. You simply write your application code like you normally would in any language or framework, describe how it should run in a simple YAML definition, and run it on Service Fabric.
|
||||
|
||||
## Model
|
||||
|
||||
Service Fabric Application Model v2 is resource-based.
|
||||
## How it works
|
||||
|
||||
At present, the following top-level resources are supported.
|
||||
Service Fabric Applications are based on **resources**. Each resource is a type of thing that can be deployed independently to Service Fabric, such as applications, services, network, volumes, or routing rules. Together, these resources compose a functioning application.
|
||||
|
||||
- Application
|
||||
- Service
|
||||
- Network
|
||||
- Volume
|
||||
Service Fabric currently supports the following resources:
|
||||
- Application and services
|
||||
- Networks
|
||||
- Volumes
|
||||
|
||||
The future releases will add support for following additional top-level resources.
|
||||
- Secret
|
||||
- Service Mesh Router
|
||||
Additional resources will be available in the future, including:
|
||||
- Secrets
|
||||
- Traffic routing rules
|
||||
- Auto-scale rules
|
||||
|
||||
### Application
|
||||
|
||||
An application is a collection of constituent services that perform a certain function or functions. The lifecycle of each application instance can be managed independently. For example, one application can be upgraded independently from other application.
|
||||
An application resource is a collection of constituent services that perform a certain function or functions. The application resource acts as a grouping construct for services that should be deployed and upgraded together as a unit. The lifecycle of each application instance can be managed independently. For example, one application can be upgraded independently from other application. Typically, you keep the number of services in an application fairly small, as the more services you put into an application.
|
||||
|
||||
### Service
|
||||
|
||||
A service performs a complete and standalone function. It can start and run independently of other services.
|
||||
|
||||
Service is composed of one or more code packages and configuration for those code packages.
|
||||
|
||||
A code package is a container image with the version tag and resources required for that container.
|
||||
|
||||
Service is also a unit of deployment and activation. All container code packages of a service are part of the pod and share same namespace. They can communicate with each other using localhost.
|
||||
A service resource describes the containers and their configuration that you want to run. Each container and the resources that you describe in the service resource is called a *code package*. Your service can container multiple code packages. This set of code packages is a unit of deployment and activation, meaning that all code packages in the service will always be run together as a pod. All containers in the service share a namespace and can communicate with each other over localhost.
|
||||
|
||||
Service can scale out by increasing its `replicaCount`. Scaling out would increase the number of running container instances for each code package.
|
||||
|
||||
|
|
|
|||
|
|
@ -20,24 +20,32 @@ SeaBreeze CLI is used to deploy and manage the resources in SeaBreeze. Set it up
|
|||
### Log in to Azure
|
||||
Log in to Azure and set your subscription to the one that has been white-listed for the preview.
|
||||
|
||||
az login
|
||||
az account set --subscription "<subscriptionName>"
|
||||
```cli
|
||||
az login
|
||||
az account set --subscription "<subscriptionName>"
|
||||
```
|
||||
|
||||
### Create resource group
|
||||
Create a resource group (RG) to deploy this example or you can use an existing resource group and skip this step. The preview is available only in `eastus` location.
|
||||
|
||||
az group create --name <resourceGroupName> --location eastus
|
||||
```cli
|
||||
az group create --name <resourceGroupName> --location eastus
|
||||
```
|
||||
|
||||
### Deploy the template
|
||||
Create the application and related resources using one of the following commands.
|
||||
|
||||
For Linux:
|
||||
|
||||
az sbz deployment create --resource-group <resourceGroupName> --template-uri https://seabreezequickstart.blob.core.windows.net/templates/azurefiles-volume/sbz_rp.linux.json
|
||||
```cli
|
||||
az sbz deployment create --resource-group <resourceGroupName> --template-uri https://seabreezequickstart.blob.core.windows.net/templates/azurefiles-volume/sbz_rp.linux.json
|
||||
```
|
||||
|
||||
For Windows:
|
||||
|
||||
az sbz deployment create --resource-group <resourceGroupName> --template-uri https://seabreezequickstart.blob.core.windows.net/templates/azurefiles-volume/sbz_rp.windows.json
|
||||
```cli
|
||||
az sbz deployment create --resource-group <resourceGroupName> --template-uri https://seabreezequickstart.blob.core.windows.net/templates/azurefiles-volume/sbz_rp.windows.json
|
||||
```
|
||||
|
||||
Follow the prompts to enter the file share name, account name, and account key for the Azure File share that provides the volume. In a minute or so, your command should return with `"provisioningState": "Succeeded"`.
|
||||
|
||||
|
|
|
|||
|
|
@ -17,28 +17,28 @@ SeaBreeze CLI is used to deploy and manage the resources in SeaBreeze. Set it up
|
|||
|
||||
### Log in to Azure
|
||||
|
||||
Log in to Azure and set your subscription to the one that has been white-listed for the preview.
|
||||
Log in to Azure and set your subscription to the one that has been white-listed for the preview.
|
||||
|
||||
```cli
|
||||
az login
|
||||
az account set --subscription "<subscriptionName>"
|
||||
```
|
||||
```cli
|
||||
az login
|
||||
az account set --subscription "<subscriptionName>"
|
||||
```
|
||||
|
||||
### Create resource group
|
||||
Create a resource group (RG) to deploy this example or you can use an existing resource group and skip this step. The preview is available only in `eastus` location.
|
||||
|
||||
```cli
|
||||
az group create --name <resourceGroupName> --location eastus
|
||||
```
|
||||
```cli
|
||||
az group create --name <resourceGroupName> --location eastus
|
||||
```
|
||||
|
||||
### Deploy the template
|
||||
|
||||
Create the application and related resources using the following command.
|
||||
|
||||
```cli
|
||||
az sbz deployment create --resource-group <resourceGroupName> --template-uri https://seabreezequickstart.blob.core.windows.net/templates/helloworld/sbz_rp.linux.json
|
||||
```cli
|
||||
az sbz deployment create --resource-group <resourceGroupName> --template-uri https://seabreezequickstart.blob.core.windows.net/templates/helloworld/sbz_rp.linux.json
|
||||
|
||||
```
|
||||
```
|
||||
In a minute or so, your command should return with `"provisioningState": "Succeeded"`. Once it does, get the public IP address by querying for the network resources created in this deployment.
|
||||
|
||||
To deploy, Windows application use[https://seabreezequickstart.blob.core.windows.net/templates/helloworld/sbz_rp.windows.json](https://seabreezequickstart.blob.core.windows.net/templates/helloworld/sbz_rp.windows.json) template. Note for Windows, container images are large compared to Linux, so it may take more time than deploying Linux application.
|
||||
|
|
|
|||
|
|
@ -13,28 +13,28 @@ SeaBreeze CLI is used to deploy and manage the resources in SeaBreeze. Set it up
|
|||
|
||||
### Log in to Azure
|
||||
|
||||
Log in to Azure and set your subscription to the one that has been white-listed for the preview.
|
||||
Log in to Azure and set your subscription to the one that has been white-listed for the preview.
|
||||
|
||||
```cli
|
||||
az login
|
||||
az account set --subscription "<subscriptionName>"
|
||||
```
|
||||
```cli
|
||||
az login
|
||||
az account set --subscription "<subscriptionName>"
|
||||
```
|
||||
### Create a container registry and push image to it
|
||||
Create Azure Container Registry by following [this](https://docs.microsoft.com/en-us/azure/container-registry/container-registry-get-started-azure-cli) guide. Perform the steps up to ["List container images"](https://docs.microsoft.com/en-us/azure/container-registry/container-registry-get-started-azure-cli#list-container-images) step. At this time, `aci-helloworld:v1` should be present in this private container registry.
|
||||
|
||||
### Retrieve credentials for the registry
|
||||
In order to deploy a container instance from the registry that was created, credentials must be provided during the deployment. The production scenarios should use a [service principal for container registry access](https://docs.microsoft.com/en-us/azure/container-registry/container-registry-auth-service-principal), but to keep this quickstart brief, enable the admin user on your registry with the following command:
|
||||
|
||||
```cli
|
||||
az acr update --name <acrName> --admin-enabled true
|
||||
```
|
||||
```cli
|
||||
az acr update --name <acrName> --admin-enabled true
|
||||
```
|
||||
Once admin access is enabled, get the registry server name, user name, and password using the following commands.
|
||||
|
||||
```cli
|
||||
az acr list --resource-group <resourceGroupName> --query "[].{acrLoginServer:loginServer}" --output table
|
||||
az acr credential show --name <acrName> --query username
|
||||
az acr credential show --name <acrName> --query "passwords[0].value"
|
||||
```
|
||||
```cli
|
||||
az acr list --resource-group <resourceGroupName> --query "[].{acrLoginServer:loginServer}" --output table
|
||||
az acr credential show --name <acrName> --query username
|
||||
az acr credential show --name <acrName> --query "passwords[0].value"
|
||||
```
|
||||
|
||||
### Deploy the template
|
||||
|
||||
|
|
@ -43,10 +43,10 @@ Create the application and related resources using the following command and pro
|
|||
> The password parameter in the template is of `string` type for ease of use. It will be displayed on the screen in clear-text and in the deployment status.
|
||||
|
||||
|
||||
```cli
|
||||
az sbz deployment create --resource-group <resourceGroupName> --template-uri https://seabreezequickstart.blob.core.windows.net/templates/private-registry/sbz_rp.linux.json
|
||||
```cli
|
||||
az sbz deployment create --resource-group <resourceGroupName> --template-uri https://seabreezequickstart.blob.core.windows.net/templates/private-registry/sbz_rp.linux.json
|
||||
|
||||
```
|
||||
```
|
||||
|
||||
In a minute or so, your command should return with `"provisioningState": "Succeeded"`. Once it does, get the public IP address by querying for the network resources created in this deployment.
|
||||
|
||||
|
|
@ -67,4 +67,4 @@ To conserve the limited resources assigned for the preview program, delete the r
|
|||
|
||||
```cli
|
||||
az group delete --resource-group <resourceGroupName>
|
||||
```
|
||||
```
|
||||
|
|
|
|||
|
|
@ -9,12 +9,12 @@ You can also install and run SeaBreeze CLI on [Cloud Shell](https://docs.microso
|
|||
|
||||
2. Remove any previous install of the SeaBreeze CLI module.
|
||||
|
||||
```cli
|
||||
az extension remove --name azure-cli-sbz
|
||||
```
|
||||
```cli
|
||||
az extension remove --name azure-cli-sbz
|
||||
```
|
||||
|
||||
3. Install the SeaBreeze CLI extension module. For the preview, SeaBreeze CLI is written as an extension to Azure CLI, however, at public preview it would ship as a part of the Azure CLI.
|
||||
|
||||
```cli
|
||||
az extension add --source https://seabreezepreview.blob.core.windows.net/cli/azure_cli_sbz-0.4.0-py2.py3-none-any.whl
|
||||
```
|
||||
```cli
|
||||
az extension add --source https://seabreezepreview.blob.core.windows.net/cli/azure_cli_sbz-0.4.0-py2.py3-none-any.whl
|
||||
```
|
||||
|
|
|
|||
Двоичный файл не отображается.
|
После Ширина: | Высота: | Размер: 16 KiB |
|
|
@ -1,38 +1,49 @@
|
|||
# Monitoring and Diagnostics SeaBreeze
|
||||
|
||||
**THIS IS AN OLD DOC, DEEP is working on a new one**
|
||||
|
||||
|
||||
Monitoring and diagnostics for SeaBreeze is generally catagorized into three main types of diagnostics data:
|
||||
|
||||
1. Application logs - these are defined as the logs from your containerized applications, based on how you have instrumented your application (docker logs)
|
||||
2. Platform container events - events from the SeaBreeze platform relevant to your container operation, currently including container activation, deactivation, termination.
|
||||
2. Platform events - events from the SeaBreeze platform relevant to your container operation, currently including container activation, deactivation, termination.
|
||||
3. Container metrics - resource utilization and performance metrics for your containers (docker stats)
|
||||
|
||||
This article discusses the monitoring and diagnostics options for the latest preview version available.
|
||||
|
||||
## Container events
|
||||
## Application logs
|
||||
|
||||
Here is a list of current container events exposed in the platform, with a brief description:
|
||||
You can view your docker logs from your deployed containers, on a per container basis. In the SeaBreeze application model, each container is a code package in your application. To see the associated logs with a code package, use the following command:
|
||||
|
||||
```cli
|
||||
az sbz codepackage logs --resource-group <nameOfResourceGroup> --app-name <nameOfCGS> --service-name <nameOfService> --replica-name <nameOfReplica> --code-package-name <nameOfCodePackage>
|
||||
```
|
||||
|
||||
*Note: currently, replica names are incrementing numbers from 0.*
|
||||
|
||||
Here is what this looks like for seeing the logs from the VotingWeb.Code container from the [quickstart](application-deployment-quickstart.md):
|
||||
|
||||
```cli
|
||||
az sbz codepackage logs --resource-group <RG> --app-name SbzVoting --service-name VotingWeb --replica-name 0 --code-package-name VotingWeb.Code
|
||||
```
|
||||
|
||||
## Platform events
|
||||
|
||||
Here is a list of current events exposed in the platform, with a brief description:
|
||||
|
||||
* ContainerActivated: container succesfully created and started
|
||||
* ContainerDeactivated – container stopped
|
||||
* ContainerTerminated – container exited with status (could be 'success' or 'error'). The container will be restarted automatically.
|
||||
|
||||
Currently, events can be viewed at a container group set (CGS) instance level. This can be for each instance, or for all instances of a CGS. Here are the Azure CLI commands to view container events.
|
||||
Currently, events can be viewed at a servicereplica level. Here is the CLI command to view container events.
|
||||
|
||||
```cli
|
||||
az sbz cgs instance --resource-group <nameOfResourceGroup> --name <nameOfCGS>
|
||||
az sbz servicereplica show <nameOfResourceGroup> --app-name <nameOfCGS> --service-name <nameOfService> --replica-name <nameOfReplica>
|
||||
```
|
||||
|
||||
Here is what this looks like for seeing events for the VotingWeb service deployed in the [quickstart](application-deployment-quickstart.md):
|
||||
|
||||
```cli
|
||||
az sbz cgs instance --resource-group <nameOfResourceGroup> --name <nameOfCGS> --instance-name <nameOfCGSInstance>
|
||||
az sbz servicereplica show --resource-group <RG> --app-name SbzVoting --service-name VotingWeb --replica-name 0
|
||||
```
|
||||
|
||||
## Application logs
|
||||
## Metrics
|
||||
|
||||
You can view your docker logs from your deployed containers, on a per container basis, using the following command:
|
||||
|
||||
```cli
|
||||
az sbz cgs logs --resource-group <nameOfResourceGroup> --name <nameOfCGS> --instance-name <nameOfCGSInstance> --container-name <nameOfContainer>
|
||||
```
|
||||
We're still working on enabling these - look for them in a future release!
|
||||
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
|
|
@ -1 +1,125 @@
|
|||
Coming soon!
|
||||
|
||||
|
||||
# SeaBreeze Resource Provider API Reference
|
||||
|
||||
Service Fabric SeaBreeze is the Service Fabric's serverless offering to enable developers to deploy containerized microservices applications without managing infrastructure.
|
||||
|
||||
Following is a list of SeaBreeze Resource Provider REST APIs to deploy and manage containerized microservices applications.
|
||||
|
||||
|
||||
----
|
||||
## [Applications APIs](seabreeze-index-applications.md)
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| [Create](seabreeze-api-application_create.md) | Creates or updates an application resource.<br/> |
|
||||
| [Get](seabreeze-api-application_get.md) | Gets the application resource.<br/> |
|
||||
| [Delete](seabreeze-api-application_delete.md) | Deletes the application resource.<br/> |
|
||||
| [List By Resource Group](seabreeze-api-application_listbyresourcegroup.md) | Gets all the application resources in a given resource group.<br/> |
|
||||
| [List By Subscription](seabreeze-api-application_listbysubscription.md) | Gets all the application resources in a given subscription.<br/> |
|
||||
|
||||
----
|
||||
## [Services APIs](seabreeze-index-services.md)
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| [List By Application Name](seabreeze-api-service_listbyapplicationname.md) | Gets services of a given application.<br/> |
|
||||
| [Get](seabreeze-api-service_get.md) | Gets the properties of the service.<br/> |
|
||||
|
||||
----
|
||||
## [Replicas APIs](seabreeze-index-replicas.md)
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| [List By Service Name](seabreeze-api-replica_listbyservicename.md) | Gets replicas of a given service.<br/> |
|
||||
| [Get](seabreeze-api-replica_get.md) | Gets a specific replica of a given service.<br/> |
|
||||
|
||||
----
|
||||
## [ContainerLogs APIs](seabreeze-index-containerlogs.md)
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| [Get Container Log](seabreeze-api-codepackage_getcontainerlog.md) | Gets the logs for the container.<br/> |
|
||||
|
||||
----
|
||||
## [Operations APIs](seabreeze-index-operations.md)
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| [List](seabreeze-api-operations_list.md) | Lists all of the available operations.<br/> |
|
||||
|
||||
----
|
||||
## [Networks APIs](seabreeze-index-networks.md)
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| [Create](seabreeze-api-network_create.md) | Creates or updates a network resource.<br/> |
|
||||
| [Get](seabreeze-api-network_get.md) | Gets the network resource.<br/> |
|
||||
| [Delete](seabreeze-api-network_delete.md) | Deletes the network resource.<br/> |
|
||||
| [List By Resource Group](seabreeze-api-network_listbyresourcegroup.md) | Gets all the network resources in a given resource group.<br/> |
|
||||
| [List By Subscription](seabreeze-api-network_listbysubscription.md) | Gets all the network resources in a given subscription.<br/> |
|
||||
|
||||
----
|
||||
## [Volumes APIs](seabreeze-index-volumes.md)
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| [Create](seabreeze-api-volume_create.md) | Creates or updates a volume resource.<br/> |
|
||||
| [Get](seabreeze-api-volume_get.md) | Gets the volume resource.<br/> |
|
||||
| [Delete](seabreeze-api-volume_delete.md) | Deletes the volume resource.<br/> |
|
||||
| [List By Resource Group](seabreeze-api-volume_listbyresourcegroup.md) | Gets all the volume resources in a given resource group.<br/> |
|
||||
| [List By Subscription](seabreeze-api-volume_listbysubscription.md) | Gets all the volume resources in a given subscription.<br/> |
|
||||
|
||||
----
|
||||
## [Models](seabreeze-index-models.md)
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| [ApplicationProperties](seabreeze-model-applicationproperties.md) | This type describes properties of an application resource.<br/> |
|
||||
| [ApplicationResourceDescription](seabreeze-model-applicationresourcedescription.md) | This type describes an application resource.<br/> |
|
||||
| [ApplicationResourceDescriptionList](seabreeze-model-applicationresourcedescriptionlist.md) | A pageable list of application resources.<br/> |
|
||||
| [ApplicationResourceProperties](seabreeze-model-applicationresourceproperties.md) | This type describes properties of an application resource.<br/> |
|
||||
| [ApplicationResourceStatus enum](seabreeze-model-applicationresourcestatus.md) | Possible values include: 'Invalid', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed'<br/> |
|
||||
| [AvailableOperationDisplay](seabreeze-model-availableoperationdisplay.md) | An operation available at the listed Azure resource provider.<br/> |
|
||||
| [ContainerCodePackageProperties](seabreeze-model-containercodepackageproperties.md) | Describes a container and its runtime properties.<br/> |
|
||||
| [ContainerEvent](seabreeze-model-containerevent.md) | A container event.<br/> |
|
||||
| [ContainerInstanceView](seabreeze-model-containerinstanceview.md) | Runtime information of a container instance.<br/> |
|
||||
| [ContainerLogs](seabreeze-model-containerlogs.md) | The logs of the container.<br/> |
|
||||
| [ContainerState](seabreeze-model-containerstate.md) | The container state.<br/> |
|
||||
| [ContainerVolume](seabreeze-model-containervolume.md) | Describes how a volume is attached to a container.<br/> |
|
||||
| [EndpointProperties](seabreeze-model-endpointproperties.md) | Describes a container endpoint.<br/> |
|
||||
| [EnvironmentVariable](seabreeze-model-environmentvariable.md) | Describes an environment variable for the container.<br/> |
|
||||
| [ErrorModel](seabreeze-model-errormodel.md) | The error details.<br/> |
|
||||
| [HealthState enum](seabreeze-model-healthstate.md) | The health state of a resource such as Application, Service, or Network.<br/> |
|
||||
| [ImageRegistryCredential](seabreeze-model-imageregistrycredential.md) | Image registry credential.<br/> |
|
||||
| [IngressConfig](seabreeze-model-ingressconfig.md) | Describes public connectivity configuration for the network.<br/> |
|
||||
| [IngressQoSLevel enum](seabreeze-model-ingressqoslevel.md) | Possible values include: 'bronze'<br/> |
|
||||
| [Layer4IngressConfig](seabreeze-model-layer4ingressconfig.md) | Describes the layer4 configuration for public connectivity for this network.<br/> |
|
||||
| [ManagedProxyResource](seabreeze-model-managedproxyresource.md) | 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.<br/> |
|
||||
| [NetworkProperties](seabreeze-model-networkproperties.md) | Describes a network.<br/> |
|
||||
| [NetworkRef](seabreeze-model-networkref.md) | Describes a network reference in a service.<br/> |
|
||||
| [NetworkResourceDescription](seabreeze-model-networkresourcedescription.md) | This type describes a network resource.<br/> |
|
||||
| [NetworkResourceDescriptionList](seabreeze-model-networkresourcedescriptionlist.md) | A pageable list of network resources.<br/> |
|
||||
| [NetworkResourceProperties](seabreeze-model-networkresourceproperties.md) | Describes properties of a network resource.<br/> |
|
||||
| [OperatingSystemTypes enum](seabreeze-model-operatingsystemtypes.md) | Possible values include: 'windows', 'linux'<br/> |
|
||||
| [OperationListResult](seabreeze-model-operationlistresult.md) | Describes the result of the request to list Service Fabric operations.<br/> |
|
||||
| [OperationResult](seabreeze-model-operationresult.md) | List of operations available at the listed Azure resource provider.<br/> |
|
||||
| [ProvisionedResourceProperties](seabreeze-model-provisionedresourceproperties.md) | Describes common properties of a provisioned resource.<br/> |
|
||||
| [ProxyResource](seabreeze-model-proxyresource.md) | The resource model definition for Azure Resource Manager proxy resource. It will have everything other than required location and tags.<br/> |
|
||||
| [Resource](seabreeze-model-resource.md) | The resource model definition for Azure Resource Manager resource.<br/> |
|
||||
| [ResourceLimits](seabreeze-model-resourcelimits.md) | 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.<br/> |
|
||||
| [ResourceRequests](seabreeze-model-resourcerequests.md) | 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.<br/> |
|
||||
| [ResourceRequirements](seabreeze-model-resourcerequirements.md) | This type describes the resource requirements for a container or a service.<br/> |
|
||||
| [ServiceList](seabreeze-model-servicelist.md) | A pageable list of all services in an application.<br/> |
|
||||
| [ServiceReplicaDescription](seabreeze-model-servicereplicadescription.md) | This type describes a replica of a service resource.<br/> |
|
||||
| [ServiceReplicaList](seabreeze-model-servicereplicalist.md) | A pageable list of replicas of a service resource.<br/> |
|
||||
| [ServiceReplicaProperties](seabreeze-model-servicereplicaproperties.md) | Describes the properties of a service replica.<br/> |
|
||||
| [ServiceResourceDescription](seabreeze-model-serviceresourcedescription.md) | This type describes a service resource.<br/> |
|
||||
| [ServiceResourceProperties](seabreeze-model-serviceresourceproperties.md) | This type describes properties of a service resource.<br/> |
|
||||
| [TrackedResource](seabreeze-model-trackedresource.md) | The resource model definition for Azure Resource Manager tracked top-level resource.<br/> |
|
||||
| [VolumeProperties](seabreeze-model-volumeproperties.md) | This type describes properties of a volume resource.<br/> |
|
||||
| [VolumeProviderParametersAzureFile](seabreeze-model-volumeproviderparametersazurefile.md) | This type describes a volume provided by an Azure Files file share.<br/> |
|
||||
| [VolumeResourceDescription](seabreeze-model-volumeresourcedescription.md) | This type describes a volume resource.<br/> |
|
||||
| [VolumeResourceDescriptionList](seabreeze-model-volumeresourcedescriptionlist.md) | A pageable list of volume resources.<br/> |
|
||||
| [VolumeResourceProperties](seabreeze-model-volumeresourceproperties.md) | Describes properties of a volume resource.<br/> |
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,136 @@
|
|||
# Create
|
||||
Creates or updates an application resource.
|
||||
|
||||
Creates an application resource with the specified name and description. If an application with the same name already exists, then its description is updated to the one indicated in this request.
|
||||
|
||||
Use network resources to provide public connectivity to the services of an application.
|
||||
|
||||
|
||||
## Request
|
||||
| Method | Request URI |
|
||||
| ------ | ----------- |
|
||||
| PUT | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/applications/{applicationName}?api-version=2018-03-01-privatepreview` |
|
||||
|
||||
|
||||
## Parameters
|
||||
| Name | Type | Required | Location |
|
||||
| --- | --- | --- | --- |
|
||||
| [`subscriptionId`](#subscriptionid) | string | Yes | Path |
|
||||
| [`resourceGroupName`](#resourcegroupname) | string | Yes | Path |
|
||||
| [`applicationName`](#applicationname) | string | Yes | Path |
|
||||
| [`api-version`](#api-version) | string | Yes | Query |
|
||||
| [`applicationResourceDescription`](#applicationresourcedescription) | [ApplicationResourceDescription](seabreeze-model-applicationresourcedescription.md) | Yes | Body |
|
||||
|
||||
____
|
||||
### `subscriptionId`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The customer subscription identifier
|
||||
|
||||
____
|
||||
### `resourceGroupName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Azure resource group name
|
||||
|
||||
____
|
||||
### `applicationName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The identity of the application.
|
||||
|
||||
____
|
||||
### `api-version`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
__Default__: `2018-03-01-privatepreview` <br/>
|
||||
<br/>
|
||||
The version of the API. This parameter is required and its value must be `2018-03-01-privatepreview`.
|
||||
|
||||
____
|
||||
### `applicationResourceDescription`
|
||||
__Type__: [ApplicationResourceDescription](seabreeze-model-applicationresourcedescription.md) <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Description for creating an application resource.
|
||||
|
||||
## Responses
|
||||
|
||||
| HTTP Status Code | Description | Response Schema |
|
||||
| --- | --- | --- |
|
||||
| 200 (OK) | Ok<br/> | [ApplicationResourceDescription](seabreeze-model-applicationresourcedescription.md) |
|
||||
| 201 (Created) | Created<br/> | [ApplicationResourceDescription](seabreeze-model-applicationresourcedescription.md) |
|
||||
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
|
||||
|
||||
## Examples
|
||||
|
||||
### ApplicationCreateOrUpdate
|
||||
|
||||
#### Request
|
||||
```
|
||||
PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sbz_demo/providers/Microsoft.ServiceFabric/applications/helloWorldApp?api-version=2018-03-01-privatepreview
|
||||
```
|
||||
|
||||
##### Body
|
||||
```json
|
||||
{
|
||||
"properties": {
|
||||
"description": "SeaBreeze HelloWorld Application!",
|
||||
"services": [
|
||||
{
|
||||
"properties": {
|
||||
"osType": "linux",
|
||||
"codePackages": [
|
||||
{
|
||||
"name": "helloWorldCode",
|
||||
"image": "seabreeze/sbz-helloworld:1.0-alpine",
|
||||
"endpoints": [
|
||||
{
|
||||
"name": "helloWorldListener",
|
||||
"port": "80"
|
||||
}
|
||||
],
|
||||
"resources": {
|
||||
"requests": {
|
||||
"memoryInGB": "1",
|
||||
"cpu": "1"
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"description": "SeaBreeze Hello World Service.",
|
||||
"replicaCount": "1"
|
||||
},
|
||||
"name": "helloWorldService"
|
||||
}
|
||||
]
|
||||
},
|
||||
"tags": {},
|
||||
"location": "EastUS"
|
||||
}
|
||||
```
|
||||
|
||||
#### 200 Response
|
||||
##### Body
|
||||
```json
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "EastUS",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/applications/myHelloWorldApp",
|
||||
"name": "myHelloWorldApp",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Updating",
|
||||
"description": "SeaBreeze HelloWorld Application!",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"helloWorldService"
|
||||
],
|
||||
"status": "Invalid"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -0,0 +1,68 @@
|
|||
# Delete
|
||||
Deletes the application resource.
|
||||
|
||||
Deletes the application resource identified by the name.
|
||||
|
||||
## Request
|
||||
| Method | Request URI |
|
||||
| ------ | ----------- |
|
||||
| DELETE | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/applications/{applicationName}?api-version=2018-03-01-privatepreview` |
|
||||
|
||||
|
||||
## Parameters
|
||||
| Name | Type | Required | Location |
|
||||
| --- | --- | --- | --- |
|
||||
| [`subscriptionId`](#subscriptionid) | string | Yes | Path |
|
||||
| [`resourceGroupName`](#resourcegroupname) | string | Yes | Path |
|
||||
| [`applicationName`](#applicationname) | string | Yes | Path |
|
||||
| [`api-version`](#api-version) | string | Yes | Query |
|
||||
|
||||
____
|
||||
### `subscriptionId`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The customer subscription identifier
|
||||
|
||||
____
|
||||
### `resourceGroupName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Azure resource group name
|
||||
|
||||
____
|
||||
### `applicationName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The identity of the application.
|
||||
|
||||
____
|
||||
### `api-version`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
__Default__: `2018-03-01-privatepreview` <br/>
|
||||
<br/>
|
||||
The version of the API. This parameter is required and its value must be `2018-03-01-privatepreview`.
|
||||
|
||||
## Responses
|
||||
|
||||
| HTTP Status Code | Description | Response Schema |
|
||||
| --- | --- | --- |
|
||||
| 200 (OK) | OK<br/> | |
|
||||
| 204 (NoContent) | No Content - the specified application was not found.<br/> | |
|
||||
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
|
||||
|
||||
## Examples
|
||||
|
||||
### ApplicationDelete
|
||||
|
||||
#### Request
|
||||
```
|
||||
DELETE https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sbz_demo/providers/Microsoft.ServiceFabric/applications/helloWorldAppWindows?api-version=2018-03-01-privatepreview
|
||||
```
|
||||
|
||||
#### 200 Response
|
||||
##### Body
|
||||
The response body is empty.
|
||||
|
|
@ -0,0 +1,85 @@
|
|||
# Get
|
||||
Gets the application resource.
|
||||
|
||||
Gets the information about the application resource with a given name. The information includes the information about the application's services and other runtime properties.
|
||||
|
||||
## Request
|
||||
| Method | Request URI |
|
||||
| ------ | ----------- |
|
||||
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/applications/{applicationName}?api-version=2018-03-01-privatepreview` |
|
||||
|
||||
|
||||
## Parameters
|
||||
| Name | Type | Required | Location |
|
||||
| --- | --- | --- | --- |
|
||||
| [`subscriptionId`](#subscriptionid) | string | Yes | Path |
|
||||
| [`resourceGroupName`](#resourcegroupname) | string | Yes | Path |
|
||||
| [`applicationName`](#applicationname) | string | Yes | Path |
|
||||
| [`api-version`](#api-version) | string | Yes | Query |
|
||||
|
||||
____
|
||||
### `subscriptionId`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The customer subscription identifier
|
||||
|
||||
____
|
||||
### `resourceGroupName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Azure resource group name
|
||||
|
||||
____
|
||||
### `applicationName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The identity of the application.
|
||||
|
||||
____
|
||||
### `api-version`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
__Default__: `2018-03-01-privatepreview` <br/>
|
||||
<br/>
|
||||
The version of the API. This parameter is required and its value must be `2018-03-01-privatepreview`.
|
||||
|
||||
## Responses
|
||||
|
||||
| HTTP Status Code | Description | Response Schema |
|
||||
| --- | --- | --- |
|
||||
| 200 (OK) | OK<br/> | [ApplicationResourceDescription](seabreeze-model-applicationresourcedescription.md) |
|
||||
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
|
||||
|
||||
## Examples
|
||||
|
||||
### ApplicationGet
|
||||
|
||||
#### Request
|
||||
```
|
||||
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sbz_demo/providers/Microsoft.ServiceFabric/applications/demo1?api-version=2018-03-01-privatepreview
|
||||
```
|
||||
|
||||
#### 200 Response
|
||||
##### Body
|
||||
```json
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/applications/helloWorldAppWindows",
|
||||
"name": "helloWorldAppWindows",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"description": "SeaBreeze HelloWorld Application!",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"helloWorldService"
|
||||
],
|
||||
"status": "Ready"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -0,0 +1,97 @@
|
|||
# List By Resource Group
|
||||
Gets all the application resources in a given resource group.
|
||||
|
||||
Gets the information about all application resources in a given resource group. The information includes the information about the application's services and other runtime properties.
|
||||
|
||||
## Request
|
||||
| Method | Request URI |
|
||||
| ------ | ----------- |
|
||||
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/applications?api-version=2018-03-01-privatepreview` |
|
||||
|
||||
|
||||
## Parameters
|
||||
| Name | Type | Required | Location |
|
||||
| --- | --- | --- | --- |
|
||||
| [`subscriptionId`](#subscriptionid) | string | Yes | Path |
|
||||
| [`resourceGroupName`](#resourcegroupname) | string | Yes | Path |
|
||||
| [`api-version`](#api-version) | string | Yes | Query |
|
||||
|
||||
____
|
||||
### `subscriptionId`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The customer subscription identifier
|
||||
|
||||
____
|
||||
### `resourceGroupName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Azure resource group name
|
||||
|
||||
____
|
||||
### `api-version`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
__Default__: `2018-03-01-privatepreview` <br/>
|
||||
<br/>
|
||||
The version of the API. This parameter is required and its value must be `2018-03-01-privatepreview`.
|
||||
|
||||
## Responses
|
||||
|
||||
| HTTP Status Code | Description | Response Schema |
|
||||
| --- | --- | --- |
|
||||
| 200 (OK) | OK<br/> | [ApplicationResourceDescriptionList](seabreeze-model-applicationresourcedescriptionlist.md) |
|
||||
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
|
||||
|
||||
## Examples
|
||||
|
||||
### ApplicationList
|
||||
|
||||
#### Request
|
||||
```
|
||||
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sbz_demo/providers/Microsoft.ServiceFabric/applications?api-version=2018-03-01-privatepreview
|
||||
```
|
||||
|
||||
#### 200 Response
|
||||
##### Body
|
||||
```json
|
||||
{
|
||||
"value": [
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/applications/helloWorldApp",
|
||||
"name": "helloWorldApp",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"description": "SeaBreeze HelloWorld Application!",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"helloWorldService"
|
||||
],
|
||||
"status": "Ready"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/applications/helloWorldAppWindows",
|
||||
"name": "helloWorldAppWindows",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"description": "SeaBreeze HelloWorld Application!",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"helloWorldService"
|
||||
],
|
||||
"status": "Ready"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -0,0 +1,218 @@
|
|||
# List By Subscription
|
||||
Gets all the application resources in a given subscription.
|
||||
|
||||
Gets the information about all application resources in a given subscription. The information includes the information about the application's services and other runtime properties.
|
||||
|
||||
## Request
|
||||
| Method | Request URI |
|
||||
| ------ | ----------- |
|
||||
| GET | `/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/applications?api-version=2018-03-01-privatepreview` |
|
||||
|
||||
|
||||
## Parameters
|
||||
| Name | Type | Required | Location |
|
||||
| --- | --- | --- | --- |
|
||||
| [`subscriptionId`](#subscriptionid) | string | Yes | Path |
|
||||
| [`api-version`](#api-version) | string | Yes | Query |
|
||||
|
||||
____
|
||||
### `subscriptionId`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The customer subscription identifier
|
||||
|
||||
____
|
||||
### `api-version`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
__Default__: `2018-03-01-privatepreview` <br/>
|
||||
<br/>
|
||||
The version of the API. This parameter is required and its value must be `2018-03-01-privatepreview`.
|
||||
|
||||
## Responses
|
||||
|
||||
| HTTP Status Code | Description | Response Schema |
|
||||
| --- | --- | --- |
|
||||
| 200 (OK) | OK<br/> | [ApplicationResourceDescriptionList](seabreeze-model-applicationresourcedescriptionlist.md) |
|
||||
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
|
||||
|
||||
## Examples
|
||||
|
||||
### ApplicationList
|
||||
|
||||
#### Request
|
||||
```
|
||||
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/applications?api-version=2018-03-01-privatepreview
|
||||
```
|
||||
|
||||
#### 200 Response
|
||||
##### Body
|
||||
```json
|
||||
{
|
||||
"value": [
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/abhisramvol/providers/Microsoft.ServiceFabric/applications/myappl",
|
||||
"name": "myappl",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"myservice"
|
||||
],
|
||||
"status": "Ready"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/abhisramvol/providers/Microsoft.ServiceFabric/applications/myappw",
|
||||
"name": "myappw",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"myservice"
|
||||
],
|
||||
"status": "Ready"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "EastUS",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/mfussellapp2/providers/Microsoft.ServiceFabric/applications/SbzVoting",
|
||||
"name": "SbzVoting",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"description": "Voting SeaBreeze!",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"VotingWeb",
|
||||
"VotingData"
|
||||
],
|
||||
"status": "Ready"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "EastUS",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/mfussellapp3/providers/Microsoft.ServiceFabric/applications/SbzVoting",
|
||||
"name": "SbzVoting",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"description": "Voting SeaBreeze!",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"VotingWeb",
|
||||
"VotingData"
|
||||
],
|
||||
"status": "Ready"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/applications/helloWorldApp",
|
||||
"name": "helloWorldApp",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"description": "SeaBreeze HelloWorld Application!",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"helloWorldService"
|
||||
],
|
||||
"status": "Ready"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/applications/helloWorldAppWindows",
|
||||
"name": "helloWorldAppWindows",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"description": "SeaBreeze HelloWorld Application!",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"helloWorldService"
|
||||
],
|
||||
"status": "Ready"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sridhar1ResourceGroup/providers/Microsoft.ServiceFabric/applications/privateRegistryExampleApp",
|
||||
"name": "privateRegistryExampleApp",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Updating",
|
||||
"description": "SeaBreeze example application with container deployed from private image registry.",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"helloWorldService"
|
||||
],
|
||||
"status": "Invalid"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sridhar4ResourceGroup/providers/Microsoft.ServiceFabric/applications/SbzVoting",
|
||||
"name": "SbzVoting",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"description": "Voting SeaBreeze!",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"VotingWeb",
|
||||
"VotingData"
|
||||
],
|
||||
"status": "Ready"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sridharResourceGroup/providers/Microsoft.ServiceFabric/applications/privateRegistryExampleApp",
|
||||
"name": "privateRegistryExampleApp",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Updating",
|
||||
"description": "SeaBreeze example application with container deployed from private image registry.",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"helloWorldService"
|
||||
],
|
||||
"status": "Invalid"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sridharRG/providers/Microsoft.ServiceFabric/applications/privateRegistryExampleApp",
|
||||
"name": "privateRegistryExampleApp",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Updating",
|
||||
"description": "SeaBreeze example application with container deployed from private image registry.",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"helloWorldService"
|
||||
],
|
||||
"status": "Invalid"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -0,0 +1,99 @@
|
|||
# Get Container Log
|
||||
Gets the logs for the container.
|
||||
|
||||
Get the logs for the container of a given code package of an application.
|
||||
|
||||
## Request
|
||||
| Method | Request URI |
|
||||
| ------ | ----------- |
|
||||
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/applications/{applicationName}/services/{serviceName}/replicas/{replicaName}/codePackages/{codePackageName}/logs?api-version=2018-03-01-privatepreview&tail={tail}` |
|
||||
|
||||
|
||||
## Parameters
|
||||
| Name | Type | Required | Location |
|
||||
| --- | --- | --- | --- |
|
||||
| [`subscriptionId`](#subscriptionid) | string | Yes | Path |
|
||||
| [`resourceGroupName`](#resourcegroupname) | string | Yes | Path |
|
||||
| [`applicationName`](#applicationname) | string | Yes | Path |
|
||||
| [`serviceName`](#servicename) | string | Yes | Path |
|
||||
| [`replicaName`](#replicaname) | string | Yes | Path |
|
||||
| [`codePackageName`](#codepackagename) | string | Yes | Path |
|
||||
| [`api-version`](#api-version) | string | Yes | Query |
|
||||
| [`tail`](#tail) | integer | No | Query |
|
||||
|
||||
____
|
||||
### `subscriptionId`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The customer subscription identifier
|
||||
|
||||
____
|
||||
### `resourceGroupName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Azure resource group name
|
||||
|
||||
____
|
||||
### `applicationName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The identity of the application.
|
||||
|
||||
____
|
||||
### `serviceName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The identity of the service.
|
||||
|
||||
____
|
||||
### `replicaName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The identity of the service replica.
|
||||
|
||||
____
|
||||
### `codePackageName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Code package name
|
||||
|
||||
____
|
||||
### `api-version`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
__Default__: `2018-03-01-privatepreview` <br/>
|
||||
<br/>
|
||||
The version of the API. This parameter is required and its value must be `2018-03-01-privatepreview`.
|
||||
|
||||
____
|
||||
### `tail`
|
||||
__Type__: integer <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Only show this number of log lines. If not provided, the last 100 lines are shown.
|
||||
|
||||
## Responses
|
||||
|
||||
| HTTP Status Code | Description | Response Schema |
|
||||
| --- | --- | --- |
|
||||
| 200 (OK) | Successful response<br/> | [ContainerLogs](seabreeze-model-containerlogs.md) |
|
||||
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
|
||||
|
||||
## Examples
|
||||
|
||||
### ContainerLogsList
|
||||
|
||||
#### Request
|
||||
```
|
||||
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sbz_demo/providers/Microsoft.ServiceFabric/applications/sbzDocApp/services/sbzDocService/replicas/0/codePackages/sbzDocCode/logs?api-version=2018-03-01-privatepreview
|
||||
```
|
||||
|
||||
#### 200 Response
|
||||
##### Body
|
||||
The response body is empty.
|
||||
|
|
@ -0,0 +1,125 @@
|
|||
# Create
|
||||
Creates or updates a network resource.
|
||||
|
||||
Creates a network resource with the specified name and description. If a network with the same name already exists, then its description is updated to the one indicated in this request.
|
||||
|
||||
Use network resources to create private network and configure public connectivity for services within your application.
|
||||
|
||||
|
||||
## Request
|
||||
| Method | Request URI |
|
||||
| ------ | ----------- |
|
||||
| PUT | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/networks/{networkName}?api-version=2018-03-01-privatepreview` |
|
||||
|
||||
|
||||
## Parameters
|
||||
| Name | Type | Required | Location |
|
||||
| --- | --- | --- | --- |
|
||||
| [`subscriptionId`](#subscriptionid) | string | Yes | Path |
|
||||
| [`resourceGroupName`](#resourcegroupname) | string | Yes | Path |
|
||||
| [`networkName`](#networkname) | string | Yes | Path |
|
||||
| [`api-version`](#api-version) | string | Yes | Query |
|
||||
| [`networkResourceDescription`](#networkresourcedescription) | [NetworkResourceDescription](seabreeze-model-networkresourcedescription.md) | Yes | Body |
|
||||
|
||||
____
|
||||
### `subscriptionId`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The customer subscription identifier
|
||||
|
||||
____
|
||||
### `resourceGroupName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Azure resource group name
|
||||
|
||||
____
|
||||
### `networkName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The identity of the network.
|
||||
|
||||
____
|
||||
### `api-version`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
__Default__: `2018-03-01-privatepreview` <br/>
|
||||
<br/>
|
||||
The version of the API. This parameter is required and its value must be `2018-03-01-privatepreview`.
|
||||
|
||||
____
|
||||
### `networkResourceDescription`
|
||||
__Type__: [NetworkResourceDescription](seabreeze-model-networkresourcedescription.md) <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Description for creating a network resource.
|
||||
|
||||
## Responses
|
||||
|
||||
| HTTP Status Code | Description | Response Schema |
|
||||
| --- | --- | --- |
|
||||
| 200 (OK) | Ok<br/> | [NetworkResourceDescription](seabreeze-model-networkresourcedescription.md) |
|
||||
| 201 (Created) | Created<br/> | [NetworkResourceDescription](seabreeze-model-networkresourcedescription.md) |
|
||||
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
|
||||
|
||||
## Examples
|
||||
|
||||
### Network_Create
|
||||
|
||||
This example shows how to create a network resource with custom address range and a load balanced public endpoint.
|
||||
|
||||
#### Request
|
||||
```
|
||||
PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sbz_demo/providers/Microsoft.ServiceFabric/networks/helloWorldNetworkWindows?api-version=2018-03-01-privatepreview
|
||||
```
|
||||
|
||||
##### Body
|
||||
```json
|
||||
{
|
||||
"properties": {
|
||||
"addressPrefix": "10.0.0.4/22",
|
||||
"ingressConfig": {
|
||||
"layer4": [
|
||||
{
|
||||
"publicPort": "80",
|
||||
"applicationName": "helloWorldAppWindows",
|
||||
"serviceName": "helloWorldService",
|
||||
"endpointName": "helloWorldListener"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"location": "eastus"
|
||||
}
|
||||
```
|
||||
|
||||
#### 200 Response
|
||||
##### Body
|
||||
```json
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/networks",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/networks/helloWorldNetworkWindows",
|
||||
"name": "helloWorldNetworkWindows",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Updating",
|
||||
"addressPrefix": "10.0.0.4/22",
|
||||
"ingressConfig": {
|
||||
"qosLevel": "Bronze",
|
||||
"layer4": [
|
||||
{
|
||||
"publicPort": "80",
|
||||
"applicationName": "helloWorldAppWindows",
|
||||
"serviceName": "helloWorldService",
|
||||
"endpointName": "helloWorldListener"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -0,0 +1,68 @@
|
|||
# Delete
|
||||
Deletes the network resource.
|
||||
|
||||
Deletes the network resource identified by the name.
|
||||
|
||||
## Request
|
||||
| Method | Request URI |
|
||||
| ------ | ----------- |
|
||||
| DELETE | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/networks/{networkName}?api-version=2018-03-01-privatepreview` |
|
||||
|
||||
|
||||
## Parameters
|
||||
| Name | Type | Required | Location |
|
||||
| --- | --- | --- | --- |
|
||||
| [`subscriptionId`](#subscriptionid) | string | Yes | Path |
|
||||
| [`resourceGroupName`](#resourcegroupname) | string | Yes | Path |
|
||||
| [`networkName`](#networkname) | string | Yes | Path |
|
||||
| [`api-version`](#api-version) | string | Yes | Query |
|
||||
|
||||
____
|
||||
### `subscriptionId`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The customer subscription identifier
|
||||
|
||||
____
|
||||
### `resourceGroupName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Azure resource group name
|
||||
|
||||
____
|
||||
### `networkName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The identity of the network.
|
||||
|
||||
____
|
||||
### `api-version`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
__Default__: `2018-03-01-privatepreview` <br/>
|
||||
<br/>
|
||||
The version of the API. This parameter is required and its value must be `2018-03-01-privatepreview`.
|
||||
|
||||
## Responses
|
||||
|
||||
| HTTP Status Code | Description | Response Schema |
|
||||
| --- | --- | --- |
|
||||
| 200 (OK) | OK<br/> | |
|
||||
| 204 (NoContent) | No Content - the specified network was not found.<br/> | |
|
||||
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
|
||||
|
||||
## Examples
|
||||
|
||||
### NetworkDelete
|
||||
|
||||
#### Request
|
||||
```
|
||||
DELETE https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sbz_demo/providers/Microsoft.ServiceFabric/networks/helloWorldNetworkWindows?api-version=2017-11-01-privatepreview
|
||||
```
|
||||
|
||||
#### 200 Response
|
||||
##### Body
|
||||
The response body is empty.
|
||||
|
|
@ -0,0 +1,93 @@
|
|||
# Get
|
||||
Gets the network resource.
|
||||
|
||||
Gets the information about the network resource with a given name. This information includes the network description and other runtime information.
|
||||
|
||||
|
||||
## Request
|
||||
| Method | Request URI |
|
||||
| ------ | ----------- |
|
||||
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/networks/{networkName}?api-version=2018-03-01-privatepreview` |
|
||||
|
||||
|
||||
## Parameters
|
||||
| Name | Type | Required | Location |
|
||||
| --- | --- | --- | --- |
|
||||
| [`subscriptionId`](#subscriptionid) | string | Yes | Path |
|
||||
| [`resourceGroupName`](#resourcegroupname) | string | Yes | Path |
|
||||
| [`networkName`](#networkname) | string | Yes | Path |
|
||||
| [`api-version`](#api-version) | string | Yes | Query |
|
||||
|
||||
____
|
||||
### `subscriptionId`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The customer subscription identifier
|
||||
|
||||
____
|
||||
### `resourceGroupName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Azure resource group name
|
||||
|
||||
____
|
||||
### `networkName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The identity of the network.
|
||||
|
||||
____
|
||||
### `api-version`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
__Default__: `2018-03-01-privatepreview` <br/>
|
||||
<br/>
|
||||
The version of the API. This parameter is required and its value must be `2018-03-01-privatepreview`.
|
||||
|
||||
## Responses
|
||||
|
||||
| HTTP Status Code | Description | Response Schema |
|
||||
| --- | --- | --- |
|
||||
| 200 (OK) | OK<br/> | [NetworkResourceDescription](seabreeze-model-networkresourcedescription.md) |
|
||||
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
|
||||
|
||||
## Examples
|
||||
|
||||
### NetworkGet
|
||||
|
||||
#### Request
|
||||
```
|
||||
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sbz_demo/providers/Microsoft.ServiceFabric/networks/helloWorldNetworkWindows?api-version=2018-03-01-privatepreview
|
||||
```
|
||||
|
||||
#### 200 Response
|
||||
##### Body
|
||||
```json
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/networks",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/networks/helloWorldNetworkWindows",
|
||||
"name": "helloWorldNetworkWindows",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"addressPrefix": "10.0.0.4/22",
|
||||
"ingressConfig": {
|
||||
"qosLevel": "Bronze",
|
||||
"publicIPAddress": "52.191.255.103",
|
||||
"layer4": [
|
||||
{
|
||||
"publicPort": "80",
|
||||
"applicationName": "helloWorldAppWindows",
|
||||
"serviceName": "helloWorldService",
|
||||
"endpointName": "helloWorldListener"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -0,0 +1,112 @@
|
|||
# List By Resource Group
|
||||
Gets all the network resources in a given resource group.
|
||||
|
||||
Gets the information about all network resources in a given resource group. The information includes the network description and other runtime properties.
|
||||
|
||||
|
||||
## Request
|
||||
| Method | Request URI |
|
||||
| ------ | ----------- |
|
||||
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/networks?api-version=2018-03-01-privatepreview` |
|
||||
|
||||
|
||||
## Parameters
|
||||
| Name | Type | Required | Location |
|
||||
| --- | --- | --- | --- |
|
||||
| [`subscriptionId`](#subscriptionid) | string | Yes | Path |
|
||||
| [`resourceGroupName`](#resourcegroupname) | string | Yes | Path |
|
||||
| [`api-version`](#api-version) | string | Yes | Query |
|
||||
|
||||
____
|
||||
### `subscriptionId`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The customer subscription identifier
|
||||
|
||||
____
|
||||
### `resourceGroupName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Azure resource group name
|
||||
|
||||
____
|
||||
### `api-version`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
__Default__: `2018-03-01-privatepreview` <br/>
|
||||
<br/>
|
||||
The version of the API. This parameter is required and its value must be `2018-03-01-privatepreview`.
|
||||
|
||||
## Responses
|
||||
|
||||
| HTTP Status Code | Description | Response Schema |
|
||||
| --- | --- | --- |
|
||||
| 200 (OK) | OK<br/> | [NetworkResourceDescriptionList](seabreeze-model-networkresourcedescriptionlist.md) |
|
||||
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
|
||||
|
||||
## Examples
|
||||
|
||||
### NetworksList
|
||||
|
||||
#### Request
|
||||
```
|
||||
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sbz_demo/providers/Microsoft.ServiceFabric/networks?api-version=2018-03-01-privatepreview
|
||||
```
|
||||
|
||||
#### 200 Response
|
||||
##### Body
|
||||
```json
|
||||
{
|
||||
"value": [
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/networks",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/networks/helloWorldNetwork",
|
||||
"name": "helloWorldNetwork",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"addressPrefix": "10.0.0.4/22",
|
||||
"ingressConfig": {
|
||||
"qosLevel": "Bronze",
|
||||
"publicIPAddress": "52.191.12.219",
|
||||
"layer4": [
|
||||
{
|
||||
"publicPort": "80",
|
||||
"applicationName": "helloWorldApp",
|
||||
"serviceName": "helloWorldService",
|
||||
"endpointName": "helloWorldListener"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/networks",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/networks/helloWorldNetworkWindows",
|
||||
"name": "helloWorldNetworkWindows",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"addressPrefix": "10.0.0.4/22",
|
||||
"ingressConfig": {
|
||||
"qosLevel": "Bronze",
|
||||
"publicIPAddress": "52.191.255.103",
|
||||
"layer4": [
|
||||
{
|
||||
"publicPort": "80",
|
||||
"applicationName": "helloWorldAppWindows",
|
||||
"serviceName": "helloWorldService",
|
||||
"endpointName": "helloWorldListener"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -0,0 +1,103 @@
|
|||
# List By Subscription
|
||||
Gets all the network resources in a given subscription.
|
||||
|
||||
Gets the information about all network resources in a given subscription. The information includes the network description and other runtime properties.
|
||||
|
||||
## Request
|
||||
| Method | Request URI |
|
||||
| ------ | ----------- |
|
||||
| GET | `/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/networks?api-version=2018-03-01-privatepreview` |
|
||||
|
||||
|
||||
## Parameters
|
||||
| Name | Type | Required | Location |
|
||||
| --- | --- | --- | --- |
|
||||
| [`subscriptionId`](#subscriptionid) | string | Yes | Path |
|
||||
| [`api-version`](#api-version) | string | Yes | Query |
|
||||
|
||||
____
|
||||
### `subscriptionId`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The customer subscription identifier
|
||||
|
||||
____
|
||||
### `api-version`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
__Default__: `2018-03-01-privatepreview` <br/>
|
||||
<br/>
|
||||
The version of the API. This parameter is required and its value must be `2018-03-01-privatepreview`.
|
||||
|
||||
## Responses
|
||||
|
||||
| HTTP Status Code | Description | Response Schema |
|
||||
| --- | --- | --- |
|
||||
| 200 (OK) | OK<br/> | [NetworkResourceDescriptionList](seabreeze-model-networkresourcedescriptionlist.md) |
|
||||
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
|
||||
|
||||
## Examples
|
||||
|
||||
### NetworksList
|
||||
|
||||
#### Request
|
||||
```
|
||||
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/networks?api-version=2018-03-01-privatepreview
|
||||
```
|
||||
|
||||
#### 200 Response
|
||||
##### Body
|
||||
```json
|
||||
{
|
||||
"value": [
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/networks",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/{resourceGroup}/providers/Microsoft.ServiceFabric/networks/helloWorldNetwork",
|
||||
"name": "helloWorldNetwork",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"addressPrefix": "10.0.0.4/22",
|
||||
"ingressConfig": {
|
||||
"qosLevel": "Bronze",
|
||||
"publicIPAddress": "52.191.12.219",
|
||||
"layer4": [
|
||||
{
|
||||
"publicPort": "80",
|
||||
"applicationName": "helloWorldApp",
|
||||
"serviceName": "helloWorldService",
|
||||
"endpointName": "helloWorldListener"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/networks",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/{resourceGroup}/providers/Microsoft.ServiceFabric/networks/helloWorldNetworkWindows",
|
||||
"name": "helloWorldNetworkWindows",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"addressPrefix": "10.0.0.4/22",
|
||||
"ingressConfig": {
|
||||
"qosLevel": "Bronze",
|
||||
"publicIPAddress": "52.191.255.103",
|
||||
"layer4": [
|
||||
{
|
||||
"publicPort": "80",
|
||||
"applicationName": "helloWorldAppWindows",
|
||||
"serviceName": "helloWorldService",
|
||||
"endpointName": "helloWorldListener"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
# List
|
||||
Lists all of the available operations.
|
||||
|
||||
Lists all the available operations provided by Service Fabric SeaBreeze resource provider.
|
||||
|
||||
## Request
|
||||
| Method | Request URI |
|
||||
| ------ | ----------- |
|
||||
| GET | `/providers/Microsoft.ServiceFabric/operations?api-version=2018-03-01-privatepreview` |
|
||||
|
||||
|
||||
## Parameters
|
||||
| Name | Type | Required | Location |
|
||||
| --- | --- | --- | --- |
|
||||
| [`api-version`](#api-version) | string | Yes | Query |
|
||||
|
||||
____
|
||||
### `api-version`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
__Default__: `2018-03-01-privatepreview` <br/>
|
||||
<br/>
|
||||
The version of the API. This parameter is required and its value must be `2018-03-01-privatepreview`.
|
||||
|
||||
## Responses
|
||||
|
||||
| HTTP Status Code | Description | Response Schema |
|
||||
| --- | --- | --- |
|
||||
| 200 (OK) | OK. The request has succeeded.<br/> | [OperationListResult](seabreeze-model-operationlistresult.md) |
|
||||
| All other status codes | Error response describing why the operation failed.<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
|
||||
|
|
@ -0,0 +1,180 @@
|
|||
# Get
|
||||
Gets a specific replica of a given service.
|
||||
|
||||
Gets the information about the specified replica of a given service of an application. The information includes the runtime properties of the replica instance.
|
||||
|
||||
## Request
|
||||
| Method | Request URI |
|
||||
| ------ | ----------- |
|
||||
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/applications/{applicationName}/services/{serviceName}/replicas/{replicaName}?api-version=2018-03-01-privatepreview` |
|
||||
|
||||
|
||||
## Parameters
|
||||
| Name | Type | Required | Location |
|
||||
| --- | --- | --- | --- |
|
||||
| [`subscriptionId`](#subscriptionid) | string | Yes | Path |
|
||||
| [`resourceGroupName`](#resourcegroupname) | string | Yes | Path |
|
||||
| [`applicationName`](#applicationname) | string | Yes | Path |
|
||||
| [`serviceName`](#servicename) | string | Yes | Path |
|
||||
| [`replicaName`](#replicaname) | string | Yes | Path |
|
||||
| [`api-version`](#api-version) | string | Yes | Query |
|
||||
|
||||
____
|
||||
### `subscriptionId`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The customer subscription identifier
|
||||
|
||||
____
|
||||
### `resourceGroupName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Azure resource group name
|
||||
|
||||
____
|
||||
### `applicationName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The identity of the application.
|
||||
|
||||
____
|
||||
### `serviceName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The identity of the service.
|
||||
|
||||
____
|
||||
### `replicaName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The identity of the service replica.
|
||||
|
||||
____
|
||||
### `api-version`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
__Default__: `2018-03-01-privatepreview` <br/>
|
||||
<br/>
|
||||
The version of the API. This parameter is required and its value must be `2018-03-01-privatepreview`.
|
||||
|
||||
## Responses
|
||||
|
||||
| HTTP Status Code | Description | Response Schema |
|
||||
| --- | --- | --- |
|
||||
| 200 (OK) | OK<br/> | [ServiceReplicaDescription](seabreeze-model-servicereplicadescription.md) |
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
### ReplicaGet
|
||||
|
||||
#### Request
|
||||
```
|
||||
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sbz_demo/providers/Microsoft.ServiceFabric/applications/helloWorldApp/services/helloWorldService/replicas/1?api-version=2018-03-01-privatepreview
|
||||
```
|
||||
|
||||
#### 200 Response
|
||||
##### Body
|
||||
```json
|
||||
{
|
||||
"osType": "Linux",
|
||||
"codePackages": [
|
||||
{
|
||||
"name": "helloWorldCode",
|
||||
"image": "seabreeze/sbz-helloworld:1.0-alpine",
|
||||
"endpoints": [
|
||||
{
|
||||
"name": "helloWorldListener",
|
||||
"port": "80"
|
||||
}
|
||||
],
|
||||
"resources": {
|
||||
"requests": {
|
||||
"memoryInGB": "1",
|
||||
"cpu": "1"
|
||||
}
|
||||
},
|
||||
"instanceView": {
|
||||
"restartCount": "1",
|
||||
"currentState": {
|
||||
"state": "Running",
|
||||
"exitCode": "0"
|
||||
},
|
||||
"previousState": {
|
||||
"state": "NotSpecified",
|
||||
"exitCode": "0"
|
||||
},
|
||||
"events": [
|
||||
{
|
||||
"count": "3",
|
||||
"firstTimestamp": "2018-04-05T22:37:20.9016844",
|
||||
"lastTimestamp": "2018-04-06T06:36:06.0887046",
|
||||
"name": "Created",
|
||||
"message": "Container created and started.",
|
||||
"type": "Normal"
|
||||
},
|
||||
{
|
||||
"count": "1",
|
||||
"firstTimestamp": "2018-04-06T06:34:00.6622454",
|
||||
"lastTimestamp": "2018-04-06T06:34:00.6622454",
|
||||
"name": "Stopped",
|
||||
"message": "Container was stopped.",
|
||||
"type": "Normal"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "helloWorldSideCar",
|
||||
"image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine",
|
||||
"resources": {
|
||||
"requests": {
|
||||
"memoryInGB": "1",
|
||||
"cpu": "1"
|
||||
}
|
||||
},
|
||||
"instanceView": {
|
||||
"restartCount": "1",
|
||||
"currentState": {
|
||||
"state": "Running",
|
||||
"exitCode": "0"
|
||||
},
|
||||
"previousState": {
|
||||
"state": "NotSpecified",
|
||||
"exitCode": "0"
|
||||
},
|
||||
"events": [
|
||||
{
|
||||
"count": "3",
|
||||
"firstTimestamp": "2018-04-05T22:37:20.906688",
|
||||
"lastTimestamp": "2018-04-06T06:36:06.0827003",
|
||||
"name": "Created",
|
||||
"message": "Container created and started.",
|
||||
"type": "Normal"
|
||||
},
|
||||
{
|
||||
"count": "1",
|
||||
"firstTimestamp": "2018-04-06T06:34:00.656241",
|
||||
"lastTimestamp": "2018-04-06T06:34:00.656241",
|
||||
"name": "Stopped",
|
||||
"message": "Container was stopped.",
|
||||
"type": "Normal"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
],
|
||||
"networkRefs": [
|
||||
{
|
||||
"name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/networks/helloWorldNetwork"
|
||||
}
|
||||
],
|
||||
"replicaName": "1"
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -0,0 +1,271 @@
|
|||
# List By Service Name
|
||||
Gets replicas of a given service.
|
||||
|
||||
Gets the information about all replicas of a given service of an application. The information includes the runtime properties of the replica instance.
|
||||
|
||||
## Request
|
||||
| Method | Request URI |
|
||||
| ------ | ----------- |
|
||||
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/applications/{applicationName}/services/{serviceName}/replicas?api-version=2018-03-01-privatepreview` |
|
||||
|
||||
|
||||
## Parameters
|
||||
| Name | Type | Required | Location |
|
||||
| --- | --- | --- | --- |
|
||||
| [`subscriptionId`](#subscriptionid) | string | Yes | Path |
|
||||
| [`resourceGroupName`](#resourcegroupname) | string | Yes | Path |
|
||||
| [`applicationName`](#applicationname) | string | Yes | Path |
|
||||
| [`serviceName`](#servicename) | string | Yes | Path |
|
||||
| [`api-version`](#api-version) | string | Yes | Query |
|
||||
|
||||
____
|
||||
### `subscriptionId`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The customer subscription identifier
|
||||
|
||||
____
|
||||
### `resourceGroupName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Azure resource group name
|
||||
|
||||
____
|
||||
### `applicationName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The identity of the application.
|
||||
|
||||
____
|
||||
### `serviceName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The identity of the service.
|
||||
|
||||
____
|
||||
### `api-version`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
__Default__: `2018-03-01-privatepreview` <br/>
|
||||
<br/>
|
||||
The version of the API. This parameter is required and its value must be `2018-03-01-privatepreview`.
|
||||
|
||||
## Responses
|
||||
|
||||
| HTTP Status Code | Description | Response Schema |
|
||||
| --- | --- | --- |
|
||||
| 200 (OK) | OK<br/> | [ServiceReplicaList](seabreeze-model-servicereplicalist.md) |
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
### ReplicasGetAll
|
||||
|
||||
#### Request
|
||||
```
|
||||
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sbz_demo/providers/Microsoft.ServiceFabric/applications/helloWorldApp/services/helloWorldService/replicas?api-version=2018-03-01-privatepreview
|
||||
```
|
||||
|
||||
#### 200 Response
|
||||
##### Body
|
||||
```json
|
||||
{
|
||||
"value": [
|
||||
{
|
||||
"osType": "Linux",
|
||||
"codePackages": [
|
||||
{
|
||||
"name": "helloWorldCode",
|
||||
"image": "seabreeze/sbz-helloworld:1.0-alpine",
|
||||
"endpoints": [
|
||||
{
|
||||
"name": "helloWorldListener",
|
||||
"port": "80"
|
||||
}
|
||||
],
|
||||
"resources": {
|
||||
"requests": {
|
||||
"memoryInGB": "1",
|
||||
"cpu": "1"
|
||||
}
|
||||
},
|
||||
"instanceView": {
|
||||
"restartCount": "1",
|
||||
"currentState": {
|
||||
"state": "Running",
|
||||
"exitCode": "0"
|
||||
},
|
||||
"previousState": {
|
||||
"state": "NotSpecified",
|
||||
"exitCode": "0"
|
||||
},
|
||||
"events": [
|
||||
{
|
||||
"count": "3",
|
||||
"firstTimestamp": "2018-04-05T22:37:20.9016844",
|
||||
"lastTimestamp": "2018-04-06T06:36:06.0887046",
|
||||
"name": "Created",
|
||||
"message": "Container created and started.",
|
||||
"type": "Normal"
|
||||
},
|
||||
{
|
||||
"count": "1",
|
||||
"firstTimestamp": "2018-04-06T06:34:00.6622454",
|
||||
"lastTimestamp": "2018-04-06T06:34:00.6622454",
|
||||
"name": "Stopped",
|
||||
"message": "Container was stopped.",
|
||||
"type": "Normal"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "helloWorldSideCar",
|
||||
"image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine",
|
||||
"resources": {
|
||||
"requests": {
|
||||
"memoryInGB": "1",
|
||||
"cpu": "1"
|
||||
}
|
||||
},
|
||||
"instanceView": {
|
||||
"restartCount": "1",
|
||||
"currentState": {
|
||||
"state": "Running",
|
||||
"exitCode": "0"
|
||||
},
|
||||
"previousState": {
|
||||
"state": "NotSpecified",
|
||||
"exitCode": "0"
|
||||
},
|
||||
"events": [
|
||||
{
|
||||
"count": "3",
|
||||
"firstTimestamp": "2018-04-05T22:37:20.906688",
|
||||
"lastTimestamp": "2018-04-06T06:36:06.0827003",
|
||||
"name": "Created",
|
||||
"message": "Container created and started.",
|
||||
"type": "Normal"
|
||||
},
|
||||
{
|
||||
"count": "1",
|
||||
"firstTimestamp": "2018-04-06T06:34:00.656241",
|
||||
"lastTimestamp": "2018-04-06T06:34:00.656241",
|
||||
"name": "Stopped",
|
||||
"message": "Container was stopped.",
|
||||
"type": "Normal"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
],
|
||||
"networkRefs": [
|
||||
{
|
||||
"name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/networks/helloWorldNetwork"
|
||||
}
|
||||
],
|
||||
"replicaName": "1"
|
||||
},
|
||||
{
|
||||
"osType": "Linux",
|
||||
"codePackages": [
|
||||
{
|
||||
"name": "helloWorldCode",
|
||||
"image": "seabreeze/sbz-helloworld:1.0-alpine",
|
||||
"endpoints": [
|
||||
{
|
||||
"name": "helloWorldListener",
|
||||
"port": "80"
|
||||
}
|
||||
],
|
||||
"resources": {
|
||||
"requests": {
|
||||
"memoryInGB": "1",
|
||||
"cpu": "1"
|
||||
}
|
||||
},
|
||||
"instanceView": {
|
||||
"restartCount": "1",
|
||||
"currentState": {
|
||||
"state": "Running",
|
||||
"exitCode": "0"
|
||||
},
|
||||
"previousState": {
|
||||
"state": "NotSpecified",
|
||||
"exitCode": "0"
|
||||
},
|
||||
"events": [
|
||||
{
|
||||
"count": "3",
|
||||
"firstTimestamp": "2018-04-05T22:37:20.9016844",
|
||||
"lastTimestamp": "2018-04-06T06:36:06.0887046",
|
||||
"name": "Created",
|
||||
"message": "Container created and started.",
|
||||
"type": "Normal"
|
||||
},
|
||||
{
|
||||
"count": "1",
|
||||
"firstTimestamp": "2018-04-06T06:34:00.6622454",
|
||||
"lastTimestamp": "2018-04-06T06:34:00.6622454",
|
||||
"name": "Stopped",
|
||||
"message": "Container was stopped.",
|
||||
"type": "Normal"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "helloWorldSideCar",
|
||||
"image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine",
|
||||
"resources": {
|
||||
"requests": {
|
||||
"memoryInGB": "1",
|
||||
"cpu": "1"
|
||||
}
|
||||
},
|
||||
"instanceView": {
|
||||
"restartCount": "1",
|
||||
"currentState": {
|
||||
"state": "Running",
|
||||
"exitCode": "0"
|
||||
},
|
||||
"previousState": {
|
||||
"state": "NotSpecified",
|
||||
"exitCode": "0"
|
||||
},
|
||||
"events": [
|
||||
{
|
||||
"count": "3",
|
||||
"firstTimestamp": "2018-04-05T22:37:20.906688",
|
||||
"lastTimestamp": "2018-04-06T06:36:06.0827003",
|
||||
"name": "Created",
|
||||
"message": "Container created and started.",
|
||||
"type": "Normal"
|
||||
},
|
||||
{
|
||||
"count": "1",
|
||||
"firstTimestamp": "2018-04-06T06:34:00.656241",
|
||||
"lastTimestamp": "2018-04-06T06:34:00.656241",
|
||||
"name": "Stopped",
|
||||
"message": "Container was stopped.",
|
||||
"type": "Normal"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
],
|
||||
"networkRefs": [
|
||||
{
|
||||
"name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/networks/helloWorldNetwork"
|
||||
}
|
||||
],
|
||||
"replicaName": "0"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -0,0 +1,122 @@
|
|||
# Get
|
||||
Gets the properties of the service.
|
||||
|
||||
The operation returns the properties of the service.
|
||||
|
||||
## Request
|
||||
| Method | Request URI |
|
||||
| ------ | ----------- |
|
||||
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/applications/{applicationName}/services/{serviceName}?api-version=2018-03-01-privatepreview` |
|
||||
|
||||
|
||||
## Parameters
|
||||
| Name | Type | Required | Location |
|
||||
| --- | --- | --- | --- |
|
||||
| [`subscriptionId`](#subscriptionid) | string | Yes | Path |
|
||||
| [`resourceGroupName`](#resourcegroupname) | string | Yes | Path |
|
||||
| [`applicationName`](#applicationname) | string | Yes | Path |
|
||||
| [`serviceName`](#servicename) | string | Yes | Path |
|
||||
| [`api-version`](#api-version) | string | Yes | Query |
|
||||
|
||||
____
|
||||
### `subscriptionId`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The customer subscription identifier
|
||||
|
||||
____
|
||||
### `resourceGroupName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Azure resource group name
|
||||
|
||||
____
|
||||
### `applicationName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The identity of the application.
|
||||
|
||||
____
|
||||
### `serviceName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The identity of the service.
|
||||
|
||||
____
|
||||
### `api-version`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
__Default__: `2018-03-01-privatepreview` <br/>
|
||||
<br/>
|
||||
The version of the API. This parameter is required and its value must be `2018-03-01-privatepreview`.
|
||||
|
||||
## Responses
|
||||
|
||||
| HTTP Status Code | Description | Response Schema |
|
||||
| --- | --- | --- |
|
||||
| 200 (OK) | OK<br/> | [ServiceResourceDescription](seabreeze-model-serviceresourcedescription.md) |
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
### ServiceGet
|
||||
|
||||
#### Request
|
||||
```
|
||||
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sbz_demo/providers/Microsoft.ServiceFabric/applications/helloWorldApp/services/helloWorldService?api-version=2018-03-01-privatepreview
|
||||
```
|
||||
|
||||
#### 200 Response
|
||||
##### Body
|
||||
```json
|
||||
{
|
||||
"name": "helloWorldService",
|
||||
"type": "Microsoft.ServiceFabric/services",
|
||||
"location": "eastus",
|
||||
"properties": {
|
||||
"osType": "Linux",
|
||||
"codePackages": [
|
||||
{
|
||||
"name": "helloWorldCode",
|
||||
"image": "seabreeze/sbz-helloworld:1.0-alpine",
|
||||
"endpoints": [
|
||||
{
|
||||
"name": "helloWorldListener",
|
||||
"port": "80"
|
||||
}
|
||||
],
|
||||
"resources": {
|
||||
"requests": {
|
||||
"memoryInGB": "1",
|
||||
"cpu": "1"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "helloWorldSideCar",
|
||||
"image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine",
|
||||
"resources": {
|
||||
"requests": {
|
||||
"memoryInGB": "1",
|
||||
"cpu": "1"
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"networkRefs": [
|
||||
{
|
||||
"name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/networks/helloWorldNetwork"
|
||||
}
|
||||
],
|
||||
"description": "SeaBreeze Hello World Service.",
|
||||
"replicaCount": "2",
|
||||
"healthState": "Ok",
|
||||
"status": "Unknown"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -0,0 +1,118 @@
|
|||
# List By Application Name
|
||||
Gets services of a given application.
|
||||
|
||||
Gets the information about all services of a given service of an application. The information includes the runtime properties of the service instance.
|
||||
|
||||
## Request
|
||||
| Method | Request URI |
|
||||
| ------ | ----------- |
|
||||
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/applications/{applicationName}/services?api-version=2018-03-01-privatepreview` |
|
||||
|
||||
|
||||
## Parameters
|
||||
| Name | Type | Required | Location |
|
||||
| --- | --- | --- | --- |
|
||||
| [`subscriptionId`](#subscriptionid) | string | Yes | Path |
|
||||
| [`resourceGroupName`](#resourcegroupname) | string | Yes | Path |
|
||||
| [`applicationName`](#applicationname) | string | Yes | Path |
|
||||
| [`api-version`](#api-version) | string | Yes | Query |
|
||||
|
||||
____
|
||||
### `subscriptionId`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The customer subscription identifier
|
||||
|
||||
____
|
||||
### `resourceGroupName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Azure resource group name
|
||||
|
||||
____
|
||||
### `applicationName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The identity of the application.
|
||||
|
||||
____
|
||||
### `api-version`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
__Default__: `2018-03-01-privatepreview` <br/>
|
||||
<br/>
|
||||
The version of the API. This parameter is required and its value must be `2018-03-01-privatepreview`.
|
||||
|
||||
## Responses
|
||||
|
||||
| HTTP Status Code | Description | Response Schema |
|
||||
| --- | --- | --- |
|
||||
| 200 (OK) | OK<br/> | [ServiceList](seabreeze-model-servicelist.md) |
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
### ServiceGetAll
|
||||
|
||||
#### Request
|
||||
```
|
||||
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sbz_demo/providers/Microsoft.ServiceFabric/applications/helloWorldApp/services?api-version=2018-03-01-privatepreview
|
||||
```
|
||||
|
||||
#### 200 Response
|
||||
##### Body
|
||||
```json
|
||||
{
|
||||
"value": [
|
||||
{
|
||||
"name": "helloWorldService",
|
||||
"type": "Microsoft.ServiceFabric/services",
|
||||
"location": "eastus",
|
||||
"properties": {
|
||||
"osType": "Linux",
|
||||
"codePackages": [
|
||||
{
|
||||
"name": "helloWorldCode",
|
||||
"image": "seabreeze/sbz-helloworld:1.0-alpine",
|
||||
"endpoints": [
|
||||
{
|
||||
"name": "helloWorldListener",
|
||||
"port": "80"
|
||||
}
|
||||
],
|
||||
"resources": {
|
||||
"requests": {
|
||||
"memoryInGB": "1",
|
||||
"cpu": "1"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "helloWorldSideCar",
|
||||
"image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine",
|
||||
"resources": {
|
||||
"requests": {
|
||||
"memoryInGB": "1",
|
||||
"cpu": "1"
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"networkRefs": [
|
||||
{
|
||||
"name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/networks/helloWorldNetwork"
|
||||
}
|
||||
],
|
||||
"description": "SeaBreeze Hello World Service.",
|
||||
"replicaCount": "1",
|
||||
"healthState": "Ok",
|
||||
"status": "Unknown"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -0,0 +1,111 @@
|
|||
# Create
|
||||
Creates or updates a volume resource.
|
||||
|
||||
Creates a volume resource with the specified name and description. If a volume with the same name already exists, then its description is updated to the one indicated in this request.
|
||||
|
||||
|
||||
## Request
|
||||
| Method | Request URI |
|
||||
| ------ | ----------- |
|
||||
| PUT | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/volumes/{volumeName}?api-version=2018-03-01-privatepreview` |
|
||||
|
||||
|
||||
## Parameters
|
||||
| Name | Type | Required | Location |
|
||||
| --- | --- | --- | --- |
|
||||
| [`subscriptionId`](#subscriptionid) | string | Yes | Path |
|
||||
| [`resourceGroupName`](#resourcegroupname) | string | Yes | Path |
|
||||
| [`volumeName`](#volumename) | string | Yes | Path |
|
||||
| [`api-version`](#api-version) | string | Yes | Query |
|
||||
| [`volumeResourceDescription`](#volumeresourcedescription) | [VolumeResourceDescription](seabreeze-model-volumeresourcedescription.md) | Yes | Body |
|
||||
|
||||
____
|
||||
### `subscriptionId`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The customer subscription identifier
|
||||
|
||||
____
|
||||
### `resourceGroupName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Azure resource group name
|
||||
|
||||
____
|
||||
### `volumeName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The identity of the volume.
|
||||
|
||||
____
|
||||
### `api-version`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
__Default__: `2018-03-01-privatepreview` <br/>
|
||||
<br/>
|
||||
The version of the API. This parameter is required and its value must be `2018-03-01-privatepreview`.
|
||||
|
||||
____
|
||||
### `volumeResourceDescription`
|
||||
__Type__: [VolumeResourceDescription](seabreeze-model-volumeresourcedescription.md) <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Description for creating a volume resource.
|
||||
|
||||
## Responses
|
||||
|
||||
| HTTP Status Code | Description | Response Schema |
|
||||
| --- | --- | --- |
|
||||
| 200 (OK) | Ok<br/> | [VolumeResourceDescription](seabreeze-model-volumeresourcedescription.md) |
|
||||
| 201 (Created) | Created<br/> | [VolumeResourceDescription](seabreeze-model-volumeresourcedescription.md) |
|
||||
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
|
||||
|
||||
## Examples
|
||||
|
||||
### VolumeCreate
|
||||
|
||||
#### Request
|
||||
```
|
||||
PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sbz_demo/providers/Microsoft.ServiceFabric/volumes/sbzDemoVolume?api-version=2018-03-01-privatepreview
|
||||
```
|
||||
|
||||
##### Body
|
||||
```json
|
||||
{
|
||||
"properties": {
|
||||
"description": "File share backed by Azure Files storage.",
|
||||
"azureFileParameters": {
|
||||
"accountName": "sbzdemoaccount",
|
||||
"accountKey": "{accountKey}",
|
||||
"shareName": "sharel"
|
||||
},
|
||||
"provider": "SFAzureFile"
|
||||
},
|
||||
"location": "eastus"
|
||||
}
|
||||
```
|
||||
|
||||
#### 200 Response
|
||||
##### Body
|
||||
```json
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/volumes",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/volumes/sbzDemoVolume",
|
||||
"name": "sbzDemoVolume",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"description": "File share backed by Azure Files storage.",
|
||||
"provider": "SFAzureFile",
|
||||
"azureFileParameters": {
|
||||
"shareName": "sharel",
|
||||
"accountName": "sbzdemoaccount"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -0,0 +1,68 @@
|
|||
# Delete
|
||||
Deletes the volume resource.
|
||||
|
||||
Deletes the volume identified by the name.
|
||||
|
||||
## Request
|
||||
| Method | Request URI |
|
||||
| ------ | ----------- |
|
||||
| DELETE | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/volumes/{volumeName}?api-version=2018-03-01-privatepreview` |
|
||||
|
||||
|
||||
## Parameters
|
||||
| Name | Type | Required | Location |
|
||||
| --- | --- | --- | --- |
|
||||
| [`subscriptionId`](#subscriptionid) | string | Yes | Path |
|
||||
| [`resourceGroupName`](#resourcegroupname) | string | Yes | Path |
|
||||
| [`volumeName`](#volumename) | string | Yes | Path |
|
||||
| [`api-version`](#api-version) | string | Yes | Query |
|
||||
|
||||
____
|
||||
### `subscriptionId`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The customer subscription identifier
|
||||
|
||||
____
|
||||
### `resourceGroupName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Azure resource group name
|
||||
|
||||
____
|
||||
### `volumeName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The identity of the volume.
|
||||
|
||||
____
|
||||
### `api-version`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
__Default__: `2018-03-01-privatepreview` <br/>
|
||||
<br/>
|
||||
The version of the API. This parameter is required and its value must be `2018-03-01-privatepreview`.
|
||||
|
||||
## Responses
|
||||
|
||||
| HTTP Status Code | Description | Response Schema |
|
||||
| --- | --- | --- |
|
||||
| 200 (OK) | OK<br/> | |
|
||||
| 204 (NoContent) | No Content - the specified volume was not found.<br/> | |
|
||||
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
|
||||
|
||||
## Examples
|
||||
|
||||
### VolumeDelete
|
||||
|
||||
#### Request
|
||||
```
|
||||
DELETE https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sbz_demo/providers/Microsoft.ServiceFabric/volumes/sbzDemoVolume?api-version=2018-03-01-privatepreview
|
||||
```
|
||||
|
||||
#### 200 Response
|
||||
##### Body
|
||||
The response body is empty.
|
||||
|
|
@ -0,0 +1,86 @@
|
|||
# Get
|
||||
Gets the volume resource.
|
||||
|
||||
Gets the information about the volume resource with a given name. This information includes the volume description and other runtime information.
|
||||
|
||||
|
||||
## Request
|
||||
| Method | Request URI |
|
||||
| ------ | ----------- |
|
||||
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/volumes/{volumeName}?api-version=2018-03-01-privatepreview` |
|
||||
|
||||
|
||||
## Parameters
|
||||
| Name | Type | Required | Location |
|
||||
| --- | --- | --- | --- |
|
||||
| [`subscriptionId`](#subscriptionid) | string | Yes | Path |
|
||||
| [`resourceGroupName`](#resourcegroupname) | string | Yes | Path |
|
||||
| [`volumeName`](#volumename) | string | Yes | Path |
|
||||
| [`api-version`](#api-version) | string | Yes | Query |
|
||||
|
||||
____
|
||||
### `subscriptionId`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The customer subscription identifier
|
||||
|
||||
____
|
||||
### `resourceGroupName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Azure resource group name
|
||||
|
||||
____
|
||||
### `volumeName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The identity of the volume.
|
||||
|
||||
____
|
||||
### `api-version`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
__Default__: `2018-03-01-privatepreview` <br/>
|
||||
<br/>
|
||||
The version of the API. This parameter is required and its value must be `2018-03-01-privatepreview`.
|
||||
|
||||
## Responses
|
||||
|
||||
| HTTP Status Code | Description | Response Schema |
|
||||
| --- | --- | --- |
|
||||
| 200 (OK) | OK<br/> | [VolumeResourceDescription](seabreeze-model-volumeresourcedescription.md) |
|
||||
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
|
||||
|
||||
## Examples
|
||||
|
||||
### VolumeGet
|
||||
|
||||
#### Request
|
||||
```
|
||||
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sbz_demo/providers/Microsoft.ServiceFabric/volumes/sbzDemoVolume?api-version=2018-03-01-privatepreview
|
||||
```
|
||||
|
||||
#### 200 Response
|
||||
##### Body
|
||||
```json
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/volumes",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/volumes/sbzDemoVolume",
|
||||
"name": "sbzDemoVolume",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"description": "File share backed by Azure Files storage.",
|
||||
"provider": "SFAzureFile",
|
||||
"azureFileParameters": {
|
||||
"shareName": "sharel",
|
||||
"accountName": "sbzdemoaccount"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -0,0 +1,98 @@
|
|||
# List By Resource Group
|
||||
Gets all the volume resources in a given resource group.
|
||||
|
||||
Gets the information about all volume resources in a given resource group. The information includes the volume description and other runtime information.
|
||||
|
||||
|
||||
## Request
|
||||
| Method | Request URI |
|
||||
| ------ | ----------- |
|
||||
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/volumes?api-version=2018-03-01-privatepreview` |
|
||||
|
||||
|
||||
## Parameters
|
||||
| Name | Type | Required | Location |
|
||||
| --- | --- | --- | --- |
|
||||
| [`subscriptionId`](#subscriptionid) | string | Yes | Path |
|
||||
| [`resourceGroupName`](#resourcegroupname) | string | Yes | Path |
|
||||
| [`api-version`](#api-version) | string | Yes | Query |
|
||||
|
||||
____
|
||||
### `subscriptionId`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The customer subscription identifier
|
||||
|
||||
____
|
||||
### `resourceGroupName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Azure resource group name
|
||||
|
||||
____
|
||||
### `api-version`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
__Default__: `2018-03-01-privatepreview` <br/>
|
||||
<br/>
|
||||
The version of the API. This parameter is required and its value must be `2018-03-01-privatepreview`.
|
||||
|
||||
## Responses
|
||||
|
||||
| HTTP Status Code | Description | Response Schema |
|
||||
| --- | --- | --- |
|
||||
| 200 (OK) | OK<br/> | [VolumeResourceDescriptionList](seabreeze-model-volumeresourcedescriptionlist.md) |
|
||||
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
|
||||
|
||||
## Examples
|
||||
|
||||
### VolumesList
|
||||
|
||||
#### Request
|
||||
```
|
||||
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sbz_demo/providers/Microsoft.ServiceFabric/volumes?api-version=2018-03-01-privatepreview
|
||||
```
|
||||
|
||||
#### 200 Response
|
||||
##### Body
|
||||
```json
|
||||
{
|
||||
"value": [
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/volumes",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/volumes/sbzDemoVolume2",
|
||||
"name": "sbzDemoShare",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"description": "File share backed by Azure Files storage.",
|
||||
"provider": "SFAzureFile",
|
||||
"azureFileParameters": {
|
||||
"shareName": "sharel",
|
||||
"accountName": "sbzdemoaccount"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/volumes",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/volumes/sbzDemoVolume",
|
||||
"name": "sbzDemoVolume",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"description": "File share backed by Azure Files storage.",
|
||||
"provider": "SFAzureFile",
|
||||
"azureFileParameters": {
|
||||
"shareName": "sharel",
|
||||
"accountName": "sbzdemoaccount"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -0,0 +1,90 @@
|
|||
# List By Subscription
|
||||
Gets all the volume resources in a given subscription.
|
||||
|
||||
Gets the information about all volume resources in a given subscription. The information includes the volume description and other runtime information.
|
||||
|
||||
|
||||
## Request
|
||||
| Method | Request URI |
|
||||
| ------ | ----------- |
|
||||
| GET | `/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/volumes?api-version=2018-03-01-privatepreview` |
|
||||
|
||||
|
||||
## Parameters
|
||||
| Name | Type | Required | Location |
|
||||
| --- | --- | --- | --- |
|
||||
| [`subscriptionId`](#subscriptionid) | string | Yes | Path |
|
||||
| [`api-version`](#api-version) | string | Yes | Query |
|
||||
|
||||
____
|
||||
### `subscriptionId`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The customer subscription identifier
|
||||
|
||||
____
|
||||
### `api-version`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
__Default__: `2018-03-01-privatepreview` <br/>
|
||||
<br/>
|
||||
The version of the API. This parameter is required and its value must be `2018-03-01-privatepreview`.
|
||||
|
||||
## Responses
|
||||
|
||||
| HTTP Status Code | Description | Response Schema |
|
||||
| --- | --- | --- |
|
||||
| 200 (OK) | OK<br/> | [VolumeResourceDescriptionList](seabreeze-model-volumeresourcedescriptionlist.md) |
|
||||
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
|
||||
|
||||
## Examples
|
||||
|
||||
### VolumesList
|
||||
|
||||
#### Request
|
||||
```
|
||||
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/volumes?api-version=2018-03-01-privatepreview
|
||||
```
|
||||
|
||||
#### 200 Response
|
||||
##### Body
|
||||
```json
|
||||
{
|
||||
"value": [
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/volumes",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbzdemo/providers/Microsoft.ServiceFabric/volumes/mysharel",
|
||||
"name": "mysharel",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"description": "File share backed by Azure Files storage.",
|
||||
"provider": "SFAzureFile",
|
||||
"azureFileParameters": {
|
||||
"shareName": "sharel",
|
||||
"accountName": "sbzdemoaccount"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/volumes",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbzdemo/providers/Microsoft.ServiceFabric/volumes/mysharew",
|
||||
"name": "mysharew",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"description": "File share backed by Azure Files storage.",
|
||||
"provider": "SFAzureFile",
|
||||
"azureFileParameters": {
|
||||
"shareName": "sharew",
|
||||
"accountName": "sbzdemoaccount"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
# Applications APIs
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| [Create](seabreeze-api-application_create.md) | Creates or updates an application resource.<br/> |
|
||||
| [Get](seabreeze-api-application_get.md) | Gets the application resource.<br/> |
|
||||
| [Delete](seabreeze-api-application_delete.md) | Deletes the application resource.<br/> |
|
||||
| [List By Resource Group](seabreeze-api-application_listbyresourcegroup.md) | Gets all the application resources in a given resource group.<br/> |
|
||||
| [List By Subscription](seabreeze-api-application_listbysubscription.md) | Gets all the application resources in a given subscription.<br/> |
|
||||
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
# ContainerLogs APIs
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| [Get Container Log](seabreeze-api-codepackage_getcontainerlog.md) | Gets the logs for the container.<br/> |
|
||||
|
||||
|
|
@ -0,0 +1,52 @@
|
|||
# Type Models
|
||||
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| [ApplicationProperties](seabreeze-model-applicationproperties.md) | This type describes properties of an application resource.<br/> |
|
||||
| [ApplicationResourceDescription](seabreeze-model-applicationresourcedescription.md) | This type describes an application resource.<br/> |
|
||||
| [ApplicationResourceDescriptionList](seabreeze-model-applicationresourcedescriptionlist.md) | A pageable list of application resources.<br/> |
|
||||
| [ApplicationResourceProperties](seabreeze-model-applicationresourceproperties.md) | This type describes properties of an application resource.<br/> |
|
||||
| [ApplicationResourceStatus enum](seabreeze-model-applicationresourcestatus.md) | Possible values include: 'Invalid', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed'<br/> |
|
||||
| [AvailableOperationDisplay](seabreeze-model-availableoperationdisplay.md) | An operation available at the listed Azure resource provider.<br/> |
|
||||
| [ContainerCodePackageProperties](seabreeze-model-containercodepackageproperties.md) | Describes a container and its runtime properties.<br/> |
|
||||
| [ContainerEvent](seabreeze-model-containerevent.md) | A container event.<br/> |
|
||||
| [ContainerInstanceView](seabreeze-model-containerinstanceview.md) | Runtime information of a container instance.<br/> |
|
||||
| [ContainerLogs](seabreeze-model-containerlogs.md) | The logs of the container.<br/> |
|
||||
| [ContainerState](seabreeze-model-containerstate.md) | The container state.<br/> |
|
||||
| [ContainerVolume](seabreeze-model-containervolume.md) | Describes how a volume is attached to a container.<br/> |
|
||||
| [EndpointProperties](seabreeze-model-endpointproperties.md) | Describes a container endpoint.<br/> |
|
||||
| [EnvironmentVariable](seabreeze-model-environmentvariable.md) | Describes an environment variable for the container.<br/> |
|
||||
| [ErrorModel](seabreeze-model-errormodel.md) | The error details.<br/> |
|
||||
| [HealthState enum](seabreeze-model-healthstate.md) | The health state of a resource such as Application, Service, or Network.<br/> |
|
||||
| [ImageRegistryCredential](seabreeze-model-imageregistrycredential.md) | Image registry credential.<br/> |
|
||||
| [IngressConfig](seabreeze-model-ingressconfig.md) | Describes public connectivity configuration for the network.<br/> |
|
||||
| [IngressQoSLevel enum](seabreeze-model-ingressqoslevel.md) | Possible values include: 'bronze'<br/> |
|
||||
| [Layer4IngressConfig](seabreeze-model-layer4ingressconfig.md) | Describes the layer4 configuration for public connectivity for this network.<br/> |
|
||||
| [ManagedProxyResource](seabreeze-model-managedproxyresource.md) | 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.<br/> |
|
||||
| [NetworkProperties](seabreeze-model-networkproperties.md) | Describes a network.<br/> |
|
||||
| [NetworkRef](seabreeze-model-networkref.md) | Describes a network reference in a service.<br/> |
|
||||
| [NetworkResourceDescription](seabreeze-model-networkresourcedescription.md) | This type describes a network resource.<br/> |
|
||||
| [NetworkResourceDescriptionList](seabreeze-model-networkresourcedescriptionlist.md) | A pageable list of network resources.<br/> |
|
||||
| [NetworkResourceProperties](seabreeze-model-networkresourceproperties.md) | Describes properties of a network resource.<br/> |
|
||||
| [OperatingSystemTypes enum](seabreeze-model-operatingsystemtypes.md) | Possible values include: 'windows', 'linux'<br/> |
|
||||
| [OperationListResult](seabreeze-model-operationlistresult.md) | Describes the result of the request to list Service Fabric operations.<br/> |
|
||||
| [OperationResult](seabreeze-model-operationresult.md) | List of operations available at the listed Azure resource provider.<br/> |
|
||||
| [ProvisionedResourceProperties](seabreeze-model-provisionedresourceproperties.md) | Describes common properties of a provisioned resource.<br/> |
|
||||
| [ProxyResource](seabreeze-model-proxyresource.md) | The resource model definition for Azure Resource Manager proxy resource. It will have everything other than required location and tags.<br/> |
|
||||
| [Resource](seabreeze-model-resource.md) | The resource model definition for Azure Resource Manager resource.<br/> |
|
||||
| [ResourceLimits](seabreeze-model-resourcelimits.md) | 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.<br/> |
|
||||
| [ResourceRequests](seabreeze-model-resourcerequests.md) | 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.<br/> |
|
||||
| [ResourceRequirements](seabreeze-model-resourcerequirements.md) | This type describes the resource requirements for a container or a service.<br/> |
|
||||
| [ServiceList](seabreeze-model-servicelist.md) | A pageable list of all services in an application.<br/> |
|
||||
| [ServiceReplicaDescription](seabreeze-model-servicereplicadescription.md) | This type describes a replica of a service resource.<br/> |
|
||||
| [ServiceReplicaList](seabreeze-model-servicereplicalist.md) | A pageable list of replicas of a service resource.<br/> |
|
||||
| [ServiceReplicaProperties](seabreeze-model-servicereplicaproperties.md) | Describes the properties of a service replica.<br/> |
|
||||
| [ServiceResourceDescription](seabreeze-model-serviceresourcedescription.md) | This type describes a service resource.<br/> |
|
||||
| [ServiceResourceProperties](seabreeze-model-serviceresourceproperties.md) | This type describes properties of a service resource.<br/> |
|
||||
| [TrackedResource](seabreeze-model-trackedresource.md) | The resource model definition for Azure Resource Manager tracked top-level resource.<br/> |
|
||||
| [VolumeProperties](seabreeze-model-volumeproperties.md) | This type describes properties of a volume resource.<br/> |
|
||||
| [VolumeProviderParametersAzureFile](seabreeze-model-volumeproviderparametersazurefile.md) | This type describes a volume provided by an Azure Files file share.<br/> |
|
||||
| [VolumeResourceDescription](seabreeze-model-volumeresourcedescription.md) | This type describes a volume resource.<br/> |
|
||||
| [VolumeResourceDescriptionList](seabreeze-model-volumeresourcedescriptionlist.md) | A pageable list of volume resources.<br/> |
|
||||
| [VolumeResourceProperties](seabreeze-model-volumeresourceproperties.md) | Describes properties of a volume resource.<br/> |
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
# Networks APIs
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| [Create](seabreeze-api-network_create.md) | Creates or updates a network resource.<br/> |
|
||||
| [Get](seabreeze-api-network_get.md) | Gets the network resource.<br/> |
|
||||
| [Delete](seabreeze-api-network_delete.md) | Deletes the network resource.<br/> |
|
||||
| [List By Resource Group](seabreeze-api-network_listbyresourcegroup.md) | Gets all the network resources in a given resource group.<br/> |
|
||||
| [List By Subscription](seabreeze-api-network_listbysubscription.md) | Gets all the network resources in a given subscription.<br/> |
|
||||
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
# Operations APIs
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| [List](seabreeze-api-operations_list.md) | Lists all of the available operations.<br/> |
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
# Replicas APIs
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| [List By Service Name](seabreeze-api-replica_listbyservicename.md) | Gets replicas of a given service.<br/> |
|
||||
| [Get](seabreeze-api-replica_get.md) | Gets a specific replica of a given service.<br/> |
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
# Services APIs
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| [List By Application Name](seabreeze-api-service_listbyapplicationname.md) | Gets services of a given application.<br/> |
|
||||
| [Get](seabreeze-api-service_get.md) | Gets the properties of the service.<br/> |
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
# Volumes APIs
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| [Create](seabreeze-api-volume_create.md) | Creates or updates a volume resource.<br/> |
|
||||
| [Get](seabreeze-api-volume_get.md) | Gets the volume resource.<br/> |
|
||||
| [Delete](seabreeze-api-volume_delete.md) | Deletes the volume resource.<br/> |
|
||||
| [List By Resource Group](seabreeze-api-volume_listbyresourcegroup.md) | Gets all the volume resources in a given resource group.<br/> |
|
||||
| [List By Subscription](seabreeze-api-volume_listbysubscription.md) | Gets all the volume resources in a given subscription.<br/> |
|
||||
|
||||
|
|
@ -0,0 +1,70 @@
|
|||
# ApplicationProperties
|
||||
|
||||
This type describes properties of an application resource.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`description`](#description) | string | No |
|
||||
| [`debugParams`](#debugparams) | string | No |
|
||||
| [`services`](#services) | array of [ServiceResourceDescription](seabreeze-model-serviceresourcedescription.md) | No |
|
||||
| [`healthState`](#healthstate) | string (enum) | No |
|
||||
| [`status`](#status) | string (enum) | No |
|
||||
| [`serviceNames`](#servicenames) | array of string | No |
|
||||
|
||||
____
|
||||
### `description`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
User readable description of the application.
|
||||
|
||||
____
|
||||
### `debugParams`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Internal use.
|
||||
|
||||
____
|
||||
### `services`
|
||||
__Type__: array of [ServiceResourceDescription](seabreeze-model-serviceresourcedescription.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
describes the services in the application.
|
||||
|
||||
____
|
||||
### `healthState`
|
||||
__Type__: string (enum) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Describes the health state of an application resource.
|
||||
|
||||
The health state of a resource such as Application, Service, or Network.
|
||||
|
||||
Possible values are:
|
||||
|
||||
- `Invalid` - Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero.
|
||||
- `Ok` - Indicates the health state is okay. The value is 1.
|
||||
- `Warning` - Indicates the health state is at a warning level. The value is 2.
|
||||
- `Error` - Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3.
|
||||
- `Unknown` - Indicates an unknown health status. The value is 65535.
|
||||
|
||||
|
||||
|
||||
____
|
||||
### `status`
|
||||
__Type__: string (enum) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Status of the application resource.
|
||||
|
||||
|
||||
|
||||
|
||||
____
|
||||
### `serviceNames`
|
||||
__Type__: array of string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Names of the services in the application.
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
# ApplicationResourceDescription
|
||||
|
||||
This type describes an application resource.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`id`](#id) | string | No |
|
||||
| [`name`](#name) | string | No |
|
||||
| [`type`](#type) | string | No |
|
||||
| [`tags`](#tags) | map of string to string | No |
|
||||
| [`location`](#location) | string | Yes |
|
||||
| [`properties`](#properties) | [ApplicationResourceProperties](seabreeze-model-applicationresourceproperties.md) | Yes |
|
||||
|
||||
____
|
||||
### `id`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
||||
|
||||
____
|
||||
### `name`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The name of the resource
|
||||
|
||||
____
|
||||
### `type`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
|
||||
|
||||
____
|
||||
### `tags`
|
||||
__Type__: map of string to string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Resource tags.
|
||||
|
||||
____
|
||||
### `location`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The geo-location where the resource lives
|
||||
|
||||
____
|
||||
### `properties`
|
||||
__Type__: [ApplicationResourceProperties](seabreeze-model-applicationresourceproperties.md) <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
This type describes properties of an application resource.
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
# ApplicationResourceDescriptionList
|
||||
|
||||
A pageable list of application resources.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`value`](#value) | array of [ApplicationResourceDescription](seabreeze-model-applicationresourcedescription.md) | No |
|
||||
| [`nextLink`](#nextlink) | string | No |
|
||||
|
||||
____
|
||||
### `value`
|
||||
__Type__: array of [ApplicationResourceDescription](seabreeze-model-applicationresourcedescription.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
One page of the list.
|
||||
|
||||
____
|
||||
### `nextLink`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
URI to fetch the next page of the list.
|
||||
|
|
@ -0,0 +1,78 @@
|
|||
# ApplicationResourceProperties
|
||||
|
||||
This type describes properties of an application resource.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`provisioningState`](#provisioningstate) | string | No |
|
||||
| [`description`](#description) | string | No |
|
||||
| [`debugParams`](#debugparams) | string | No |
|
||||
| [`services`](#services) | array of [ServiceResourceDescription](seabreeze-model-serviceresourcedescription.md) | No |
|
||||
| [`healthState`](#healthstate) | string (enum) | No |
|
||||
| [`status`](#status) | string (enum) | No |
|
||||
| [`serviceNames`](#servicenames) | array of string | No |
|
||||
|
||||
____
|
||||
### `provisioningState`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
State of the resource.
|
||||
|
||||
____
|
||||
### `description`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
User readable description of the application.
|
||||
|
||||
____
|
||||
### `debugParams`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Internal use.
|
||||
|
||||
____
|
||||
### `services`
|
||||
__Type__: array of [ServiceResourceDescription](seabreeze-model-serviceresourcedescription.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
describes the services in the application.
|
||||
|
||||
____
|
||||
### `healthState`
|
||||
__Type__: string (enum) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
The health state of a resource such as Application, Service, or Network.
|
||||
|
||||
Possible values are:
|
||||
|
||||
- `Invalid` - Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero.
|
||||
- `Ok` - Indicates the health state is okay. The value is 1.
|
||||
- `Warning` - Indicates the health state is at a warning level. The value is 2.
|
||||
- `Error` - Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3.
|
||||
- `Unknown` - Indicates an unknown health status. The value is 65535.
|
||||
|
||||
|
||||
|
||||
____
|
||||
### `status`
|
||||
__Type__: string (enum) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
____
|
||||
### `serviceNames`
|
||||
__Type__: array of string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Names of the services in the application.
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
# ApplicationResourceStatus enum
|
||||
|
||||
type: string
|
||||
|
||||
Possible values include: 'Invalid', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed'
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
# AvailableOperationDisplay
|
||||
|
||||
An operation available at the listed Azure resource provider.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`provider`](#provider) | string | No |
|
||||
| [`resource`](#resource) | string | No |
|
||||
| [`operation`](#operation) | string | No |
|
||||
| [`description`](#description) | string | No |
|
||||
|
||||
____
|
||||
### `provider`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Name of the operation provider.
|
||||
|
||||
____
|
||||
### `resource`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Name of the resource on which the operation is available.
|
||||
|
||||
____
|
||||
### `operation`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Name of the available operation.
|
||||
|
||||
____
|
||||
### `description`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Description of the available operation.
|
||||
|
|
@ -0,0 +1,87 @@
|
|||
# ContainerCodePackageProperties
|
||||
|
||||
Describes a container and its runtime properties.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`name`](#name) | string | Yes |
|
||||
| [`image`](#image) | string | Yes |
|
||||
| [`imageRegistryCredential`](#imageregistrycredential) | [ImageRegistryCredential](seabreeze-model-imageregistrycredential.md) | No |
|
||||
| [`entrypoint`](#entrypoint) | string | No |
|
||||
| [`commands`](#commands) | array of string | No |
|
||||
| [`environmentVariables`](#environmentvariables) | array of [EnvironmentVariable](seabreeze-model-environmentvariable.md) | No |
|
||||
| [`endpoints`](#endpoints) | array of [EndpointProperties](seabreeze-model-endpointproperties.md) | No |
|
||||
| [`resources`](#resources) | [ResourceRequirements](seabreeze-model-resourcerequirements.md) | Yes |
|
||||
| [`volumeRefs`](#volumerefs) | array of [ContainerVolume](seabreeze-model-containervolume.md) | No |
|
||||
| [`instanceView`](#instanceview) | [ContainerInstanceView](seabreeze-model-containerinstanceview.md) | No |
|
||||
|
||||
____
|
||||
### `name`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The name of the code package.
|
||||
|
||||
____
|
||||
### `image`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The Container image to use.
|
||||
|
||||
____
|
||||
### `imageRegistryCredential`
|
||||
__Type__: [ImageRegistryCredential](seabreeze-model-imageregistrycredential.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Image registry credential.
|
||||
|
||||
____
|
||||
### `entrypoint`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Override for the default entry point in the container.
|
||||
|
||||
____
|
||||
### `commands`
|
||||
__Type__: array of string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Command array to execute within the container in exec form.
|
||||
|
||||
____
|
||||
### `environmentVariables`
|
||||
__Type__: array of [EnvironmentVariable](seabreeze-model-environmentvariable.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The environment variables to set in this container
|
||||
|
||||
____
|
||||
### `endpoints`
|
||||
__Type__: array of [EndpointProperties](seabreeze-model-endpointproperties.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The endpoints exposed by this container.
|
||||
|
||||
____
|
||||
### `resources`
|
||||
__Type__: [ResourceRequirements](seabreeze-model-resourcerequirements.md) <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
This type describes the resource requirements for a container or a service.
|
||||
|
||||
____
|
||||
### `volumeRefs`
|
||||
__Type__: array of [ContainerVolume](seabreeze-model-containervolume.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The volumes to be attached to the container.
|
||||
|
||||
____
|
||||
### `instanceView`
|
||||
__Type__: [ContainerInstanceView](seabreeze-model-containerinstanceview.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Runtime information of a container instance.
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
# ContainerEvent
|
||||
|
||||
A container event.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`count`](#count) | integer | No |
|
||||
| [`firstTimestamp`](#firsttimestamp) | string (date-time) | No |
|
||||
| [`lastTimestamp`](#lasttimestamp) | string (date-time) | No |
|
||||
| [`message`](#message) | string | No |
|
||||
| [`type`](#type) | string | No |
|
||||
|
||||
____
|
||||
### `count`
|
||||
__Type__: integer <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The count of the event.
|
||||
|
||||
____
|
||||
### `firstTimestamp`
|
||||
__Type__: string (date-time) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Date/time of the first event.
|
||||
|
||||
____
|
||||
### `lastTimestamp`
|
||||
__Type__: string (date-time) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Date/time of the last event.
|
||||
|
||||
____
|
||||
### `message`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The event message
|
||||
|
||||
____
|
||||
### `type`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The event type.
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
# ContainerInstanceView
|
||||
|
||||
Runtime information of a container instance.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`restartCount`](#restartcount) | integer | No |
|
||||
| [`currentState`](#currentstate) | [ContainerState](seabreeze-model-containerstate.md) | No |
|
||||
| [`previousState`](#previousstate) | [ContainerState](seabreeze-model-containerstate.md) | No |
|
||||
| [`events`](#events) | array of [ContainerEvent](seabreeze-model-containerevent.md) | No |
|
||||
|
||||
____
|
||||
### `restartCount`
|
||||
__Type__: integer <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The number of times the container has been restarted.
|
||||
|
||||
____
|
||||
### `currentState`
|
||||
__Type__: [ContainerState](seabreeze-model-containerstate.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Current container instance state.
|
||||
|
||||
____
|
||||
### `previousState`
|
||||
__Type__: [ContainerState](seabreeze-model-containerstate.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Previous container instance state.
|
||||
|
||||
____
|
||||
### `events`
|
||||
__Type__: array of [ContainerEvent](seabreeze-model-containerevent.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The events of this container instance.
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
# ContainerLogs
|
||||
|
||||
The logs of the container.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`content`](#content) | string | No |
|
||||
|
||||
____
|
||||
### `content`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
content of the log.
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
# ContainerState
|
||||
|
||||
The container state.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`state`](#state) | string | No |
|
||||
| [`startTime`](#starttime) | string (date-time) | No |
|
||||
| [`exitCode`](#exitcode) | string | No |
|
||||
| [`finishTime`](#finishtime) | string (date-time) | No |
|
||||
| [`detailStatus`](#detailstatus) | string | No |
|
||||
|
||||
____
|
||||
### `state`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The state of this container
|
||||
|
||||
____
|
||||
### `startTime`
|
||||
__Type__: string (date-time) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Date/time when the container state started.
|
||||
|
||||
____
|
||||
### `exitCode`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The container exit code.
|
||||
|
||||
____
|
||||
### `finishTime`
|
||||
__Type__: string (date-time) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Date/time when the container state finished.
|
||||
|
||||
____
|
||||
### `detailStatus`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Human-readable status of this state.
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
# ContainerVolume
|
||||
|
||||
Describes how a volume is attached to a container.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`name`](#name) | string | Yes |
|
||||
| [`readOnly`](#readonly) | boolean | No |
|
||||
| [`destinationPath`](#destinationpath) | string | Yes |
|
||||
|
||||
____
|
||||
### `name`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Name of the volume.
|
||||
|
||||
____
|
||||
### `readOnly`
|
||||
__Type__: boolean <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The flag indicating whether the volume is read only. Default is 'false'.
|
||||
|
||||
____
|
||||
### `destinationPath`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The path within the container at which the volume should be mounted. Only valid path characters are allowed.
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
# EndpointProperties
|
||||
|
||||
Describes a container endpoint.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`name`](#name) | string | Yes |
|
||||
| [`port`](#port) | integer | No |
|
||||
|
||||
____
|
||||
### `name`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The name of the endpoint.
|
||||
|
||||
____
|
||||
### `port`
|
||||
__Type__: integer <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Port used by the container.
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
# EnvironmentVariable
|
||||
|
||||
Describes an environment variable for the container.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`name`](#name) | string | No |
|
||||
| [`value`](#value) | string | No |
|
||||
|
||||
____
|
||||
### `name`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The name of the environment variable.
|
||||
|
||||
____
|
||||
### `value`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The value of the environment variable.
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
# ErrorModel
|
||||
|
||||
The error details.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`code`](#code) | string | No |
|
||||
| [`message`](#message) | string | No |
|
||||
|
||||
____
|
||||
### `code`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The error code.
|
||||
|
||||
____
|
||||
### `message`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The error message.
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
# HealthState enum
|
||||
|
||||
type: string
|
||||
|
||||
The health state of a resource such as Application, Service, or Network.
|
||||
|
||||
Possible values are:
|
||||
|
||||
- `Invalid` - Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero.
|
||||
- `Ok` - Indicates the health state is okay. The value is 1.
|
||||
- `Warning` - Indicates the health state is at a warning level. The value is 2.
|
||||
- `Error` - Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3.
|
||||
- `Unknown` - Indicates an unknown health status. The value is 65535.
|
||||
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
# ImageRegistryCredential
|
||||
|
||||
Image registry credential.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`server`](#server) | string | Yes |
|
||||
| [`username`](#username) | string | Yes |
|
||||
| [`password`](#password) | string | No |
|
||||
|
||||
____
|
||||
### `server`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Docker image registry server, without protocol such as `http` and `https`.
|
||||
|
||||
____
|
||||
### `username`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The username for the private registry.
|
||||
|
||||
____
|
||||
### `password`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The password for the private registry.
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
# IngressConfig
|
||||
|
||||
Describes public connectivity configuration for the network.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`qosLevel`](#qoslevel) | string (enum) | No |
|
||||
| [`layer4`](#layer4) | array of [Layer4IngressConfig](seabreeze-model-layer4ingressconfig.md) | No |
|
||||
| [`publicIPAddress`](#publicipaddress) | string | No |
|
||||
|
||||
____
|
||||
### `qosLevel`
|
||||
__Type__: string (enum) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The QoS tier for ingress.
|
||||
|
||||
|
||||
|
||||
|
||||
____
|
||||
### `layer4`
|
||||
__Type__: array of [Layer4IngressConfig](seabreeze-model-layer4ingressconfig.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Configuration for layer4 public connectivity for this network.
|
||||
|
||||
____
|
||||
### `publicIPAddress`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The public IP address for reaching this network.
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
# IngressQoSLevel enum
|
||||
|
||||
type: string
|
||||
|
||||
Possible values include: 'bronze'
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
# Layer4IngressConfig
|
||||
|
||||
Describes the layer4 configuration for public connectivity for this network.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`publicPort`](#publicport) | string | No |
|
||||
| [`applicationName`](#applicationname) | string | No |
|
||||
| [`serviceName`](#servicename) | string | No |
|
||||
| [`endpointName`](#endpointname) | string | No |
|
||||
|
||||
____
|
||||
### `publicPort`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Specifies the public port at which the service endpoint below needs to be exposed.
|
||||
|
||||
____
|
||||
### `applicationName`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The application name which contains the service to be exposed.
|
||||
|
||||
____
|
||||
### `serviceName`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The service whose endpoint needs to be exposed at the public port.
|
||||
|
||||
____
|
||||
### `endpointName`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The service endpoint that needs to be exposed.
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
# ManagedProxyResource
|
||||
|
||||
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.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`id`](#id) | string | No |
|
||||
| [`name`](#name) | string | No |
|
||||
| [`type`](#type) | string | No |
|
||||
|
||||
____
|
||||
### `id`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
||||
|
||||
____
|
||||
### `name`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The name of the resource
|
||||
|
||||
____
|
||||
### `type`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
# NetworkProperties
|
||||
|
||||
Describes a network.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`description`](#description) | string | No |
|
||||
| [`addressPrefix`](#addressprefix) | string | Yes |
|
||||
| [`ingressConfig`](#ingressconfig) | [IngressConfig](seabreeze-model-ingressconfig.md) | No |
|
||||
|
||||
____
|
||||
### `description`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
User readable description of the network.
|
||||
|
||||
____
|
||||
### `addressPrefix`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
the address prefix for this network.
|
||||
|
||||
____
|
||||
### `ingressConfig`
|
||||
__Type__: [IngressConfig](seabreeze-model-ingressconfig.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Configuration for public connectivity for this network.
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
# NetworkRef
|
||||
|
||||
Describes a network reference in a service.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`name`](#name) | string | No |
|
||||
|
||||
____
|
||||
### `name`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Name of the network.
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
# NetworkResourceDescription
|
||||
|
||||
This type describes a network resource.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`id`](#id) | string | No |
|
||||
| [`name`](#name) | string | No |
|
||||
| [`type`](#type) | string | No |
|
||||
| [`tags`](#tags) | map of string to string | No |
|
||||
| [`location`](#location) | string | Yes |
|
||||
| [`properties`](#properties) | [NetworkResourceProperties](seabreeze-model-networkresourceproperties.md) | Yes |
|
||||
|
||||
____
|
||||
### `id`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
||||
|
||||
____
|
||||
### `name`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The name of the resource
|
||||
|
||||
____
|
||||
### `type`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
|
||||
|
||||
____
|
||||
### `tags`
|
||||
__Type__: map of string to string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Resource tags.
|
||||
|
||||
____
|
||||
### `location`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The geo-location where the resource lives
|
||||
|
||||
____
|
||||
### `properties`
|
||||
__Type__: [NetworkResourceProperties](seabreeze-model-networkresourceproperties.md) <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Describes properties of a network resource.
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
# NetworkResourceDescriptionList
|
||||
|
||||
A pageable list of network resources.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`value`](#value) | array of [NetworkResourceDescription](seabreeze-model-networkresourcedescription.md) | No |
|
||||
| [`nextLink`](#nextlink) | string | No |
|
||||
|
||||
____
|
||||
### `value`
|
||||
__Type__: array of [NetworkResourceDescription](seabreeze-model-networkresourcedescription.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
One page of the list.
|
||||
|
||||
____
|
||||
### `nextLink`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
URI to fetch the next page of the list.
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
# NetworkResourceProperties
|
||||
|
||||
Describes properties of a network resource.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`provisioningState`](#provisioningstate) | string | No |
|
||||
| [`description`](#description) | string | No |
|
||||
| [`addressPrefix`](#addressprefix) | string | Yes |
|
||||
| [`ingressConfig`](#ingressconfig) | [IngressConfig](seabreeze-model-ingressconfig.md) | No |
|
||||
|
||||
____
|
||||
### `provisioningState`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
State of the resource.
|
||||
|
||||
____
|
||||
### `description`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
User readable description of the network.
|
||||
|
||||
____
|
||||
### `addressPrefix`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
the address prefix for this network.
|
||||
|
||||
____
|
||||
### `ingressConfig`
|
||||
__Type__: [IngressConfig](seabreeze-model-ingressconfig.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Configuration for public connectivity for this network.
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
# OperatingSystemTypes enum
|
||||
|
||||
type: string
|
||||
|
||||
Possible values include: 'windows', 'linux'
|
||||
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
# OperationListResult
|
||||
|
||||
Describes the result of the request to list Service Fabric operations.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`value`](#value) | array of [OperationResult](seabreeze-model-operationresult.md) | No |
|
||||
| [`nextLink`](#nextlink) | string | No |
|
||||
|
||||
____
|
||||
### `value`
|
||||
__Type__: array of [OperationResult](seabreeze-model-operationresult.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
List of Service Fabric operations supported by the Microsoft.ServiceFabric resource provider.
|
||||
|
||||
____
|
||||
### `nextLink`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
URL to get the next set of operation list results if there are any.
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
# OperationResult
|
||||
|
||||
List of operations available at the listed Azure resource provider.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`name`](#name) | string | No |
|
||||
| [`display`](#display) | [AvailableOperationDisplay](seabreeze-model-availableoperationdisplay.md) | No |
|
||||
| [`origin`](#origin) | string | No |
|
||||
| [`nextLink`](#nextlink) | string | No |
|
||||
|
||||
____
|
||||
### `name`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The name of the operation.
|
||||
|
||||
____
|
||||
### `display`
|
||||
__Type__: [AvailableOperationDisplay](seabreeze-model-availableoperationdisplay.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The object that represents the operation.
|
||||
|
||||
____
|
||||
### `origin`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Origin result
|
||||
|
||||
____
|
||||
### `nextLink`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The URL to use for getting the next set of results.
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
# ProvisionedResourceProperties
|
||||
|
||||
Describes common properties of a provisioned resource.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`provisioningState`](#provisioningstate) | string | No |
|
||||
|
||||
____
|
||||
### `provisioningState`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
State of the resource.
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
# ProxyResource
|
||||
|
||||
The resource model definition for Azure Resource Manager proxy resource. It will have everything other than required location and tags.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`id`](#id) | string | No |
|
||||
| [`name`](#name) | string | No |
|
||||
| [`type`](#type) | string | No |
|
||||
|
||||
____
|
||||
### `id`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
||||
|
||||
____
|
||||
### `name`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The name of the resource
|
||||
|
||||
____
|
||||
### `type`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
# Resource
|
||||
|
||||
The resource model definition for Azure Resource Manager resource.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`id`](#id) | string | No |
|
||||
| [`name`](#name) | string | No |
|
||||
| [`type`](#type) | string | No |
|
||||
|
||||
____
|
||||
### `id`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
||||
|
||||
____
|
||||
### `name`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The name of the resource
|
||||
|
||||
____
|
||||
### `type`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
# ResourceLimits
|
||||
|
||||
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.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`memoryInGB`](#memoryingb) | number (double) | No |
|
||||
| [`cpu`](#cpu) | number (double) | No |
|
||||
|
||||
____
|
||||
### `memoryInGB`
|
||||
__Type__: number (double) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The memory limit in GB.
|
||||
|
||||
____
|
||||
### `cpu`
|
||||
__Type__: number (double) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
CPU limits in cores. At present, only full cores are supported.
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# ResourceRequests
|
||||
|
||||
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.
|
||||
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`memoryInGB`](#memoryingb) | number (double) | Yes |
|
||||
| [`cpu`](#cpu) | number (double) | Yes |
|
||||
|
||||
____
|
||||
### `memoryInGB`
|
||||
__Type__: number (double) <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The memory request in GB for this container.
|
||||
|
||||
____
|
||||
### `cpu`
|
||||
__Type__: number (double) <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Requested number of CPU cores. At present, only full cores are supported.
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
# ResourceRequirements
|
||||
|
||||
This type describes the resource requirements for a container or a service.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`requests`](#requests) | [ResourceRequests](seabreeze-model-resourcerequests.md) | Yes |
|
||||
| [`limits`](#limits) | [ResourceLimits](seabreeze-model-resourcelimits.md) | No |
|
||||
|
||||
____
|
||||
### `requests`
|
||||
__Type__: [ResourceRequests](seabreeze-model-resourcerequests.md) <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Describes the requested resources for a given container.
|
||||
|
||||
____
|
||||
### `limits`
|
||||
__Type__: [ResourceLimits](seabreeze-model-resourcelimits.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Describes the maximum limits on the resources for a given container.
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# ServiceList
|
||||
|
||||
A pageable list of all services in an application.
|
||||
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`value`](#value) | array of [ServiceResourceDescription](seabreeze-model-serviceresourcedescription.md) | No |
|
||||
| [`nextLink`](#nextlink) | string | No |
|
||||
|
||||
____
|
||||
### `value`
|
||||
__Type__: array of [ServiceResourceDescription](seabreeze-model-serviceresourcedescription.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
One page of the list.
|
||||
|
||||
____
|
||||
### `nextLink`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
URI to fetch the next page of the list.
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
# ServiceReplicaDescription
|
||||
|
||||
This type describes a replica of a service resource.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`osType`](#ostype) | string (enum) | Yes |
|
||||
| [`codePackages`](#codepackages) | array of [ContainerCodePackageProperties](seabreeze-model-containercodepackageproperties.md) | Yes |
|
||||
| [`networkRefs`](#networkrefs) | array of [NetworkRef](seabreeze-model-networkref.md) | No |
|
||||
| [`replicaName`](#replicaname) | string | No |
|
||||
|
||||
____
|
||||
### `osType`
|
||||
__Type__: string (enum) <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The Operating system type required by the code in service.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
____
|
||||
### `codePackages`
|
||||
__Type__: array of [ContainerCodePackageProperties](seabreeze-model-containercodepackageproperties.md) <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
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.).
|
||||
|
||||
|
||||
____
|
||||
### `networkRefs`
|
||||
__Type__: array of [NetworkRef](seabreeze-model-networkref.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The names of the private networks that this service needs to be part of.
|
||||
|
||||
____
|
||||
### `replicaName`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Name of the replica.
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# ServiceReplicaList
|
||||
|
||||
A pageable list of replicas of a service resource.
|
||||
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`value`](#value) | array of [ServiceReplicaDescription](seabreeze-model-servicereplicadescription.md) | No |
|
||||
| [`nextLink`](#nextlink) | string | No |
|
||||
|
||||
____
|
||||
### `value`
|
||||
__Type__: array of [ServiceReplicaDescription](seabreeze-model-servicereplicadescription.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
One page of the list.
|
||||
|
||||
____
|
||||
### `nextLink`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
URI to fetch the next page of the list.
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
# ServiceReplicaProperties
|
||||
|
||||
Describes the properties of a service replica.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`osType`](#ostype) | string (enum) | Yes |
|
||||
| [`codePackages`](#codepackages) | array of [ContainerCodePackageProperties](seabreeze-model-containercodepackageproperties.md) | Yes |
|
||||
| [`networkRefs`](#networkrefs) | array of [NetworkRef](seabreeze-model-networkref.md) | No |
|
||||
|
||||
____
|
||||
### `osType`
|
||||
__Type__: string (enum) <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The Operating system type required by the code in service.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
____
|
||||
### `codePackages`
|
||||
__Type__: array of [ContainerCodePackageProperties](seabreeze-model-containercodepackageproperties.md) <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
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.).
|
||||
|
||||
|
||||
____
|
||||
### `networkRefs`
|
||||
__Type__: array of [NetworkRef](seabreeze-model-networkref.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The names of the private networks that this service needs to be part of.
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
# ServiceResourceDescription
|
||||
|
||||
This type describes a service resource.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`id`](#id) | string | No |
|
||||
| [`name`](#name) | string | No |
|
||||
| [`type`](#type) | string | No |
|
||||
| [`properties`](#properties) | [ServiceResourceProperties](seabreeze-model-serviceresourceproperties.md) | Yes |
|
||||
|
||||
____
|
||||
### `id`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
||||
|
||||
____
|
||||
### `name`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The name of the resource
|
||||
|
||||
____
|
||||
### `type`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
|
||||
|
||||
____
|
||||
### `properties`
|
||||
__Type__: [ServiceResourceProperties](seabreeze-model-serviceresourceproperties.md) <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
This type describes properties of a service resource.
|
||||
|
|
@ -0,0 +1,83 @@
|
|||
# ServiceResourceProperties
|
||||
|
||||
This type describes properties of a service resource.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`osType`](#ostype) | string (enum) | Yes |
|
||||
| [`codePackages`](#codepackages) | array of [ContainerCodePackageProperties](seabreeze-model-containercodepackageproperties.md) | Yes |
|
||||
| [`networkRefs`](#networkrefs) | array of [NetworkRef](seabreeze-model-networkref.md) | No |
|
||||
| [`description`](#description) | string | No |
|
||||
| [`replicaCount`](#replicacount) | integer | No |
|
||||
| [`healthState`](#healthstate) | string (enum) | No |
|
||||
| [`status`](#status) | string (enum) | No |
|
||||
|
||||
____
|
||||
### `osType`
|
||||
__Type__: string (enum) <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The Operating system type required by the code in service.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
____
|
||||
### `codePackages`
|
||||
__Type__: array of [ContainerCodePackageProperties](seabreeze-model-containercodepackageproperties.md) <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
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.).
|
||||
|
||||
|
||||
____
|
||||
### `networkRefs`
|
||||
__Type__: array of [NetworkRef](seabreeze-model-networkref.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The names of the private networks that this service needs to be part of.
|
||||
|
||||
____
|
||||
### `description`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
User readable description of the service.
|
||||
|
||||
____
|
||||
### `replicaCount`
|
||||
__Type__: integer <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The number of replicas of the service to create. Defaults to 1 if not specified.
|
||||
|
||||
____
|
||||
### `healthState`
|
||||
__Type__: string (enum) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Describes the health state of an services resource.
|
||||
|
||||
The health state of a resource such as Application, Service, or Network.
|
||||
|
||||
Possible values are:
|
||||
|
||||
- `Invalid` - Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero.
|
||||
- `Ok` - Indicates the health state is okay. The value is 1.
|
||||
- `Warning` - Indicates the health state is at a warning level. The value is 2.
|
||||
- `Error` - Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3.
|
||||
- `Unknown` - Indicates an unknown health status. The value is 65535.
|
||||
|
||||
|
||||
|
||||
____
|
||||
### `status`
|
||||
__Type__: string (enum) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
# TrackedResource
|
||||
|
||||
The resource model definition for Azure Resource Manager tracked top-level resource.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`id`](#id) | string | No |
|
||||
| [`name`](#name) | string | No |
|
||||
| [`type`](#type) | string | No |
|
||||
| [`tags`](#tags) | map of string to string | No |
|
||||
| [`location`](#location) | string | Yes |
|
||||
|
||||
____
|
||||
### `id`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
||||
|
||||
____
|
||||
### `name`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The name of the resource
|
||||
|
||||
____
|
||||
### `type`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
|
||||
|
||||
____
|
||||
### `tags`
|
||||
__Type__: map of string to string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Resource tags.
|
||||
|
||||
____
|
||||
### `location`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The geo-location where the resource lives
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
# VolumeProperties
|
||||
|
||||
This type describes properties of a volume resource.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`description`](#description) | string | No |
|
||||
| [`provider`](#provider) | string | Yes |
|
||||
| [`azureFileParameters`](#azurefileparameters) | [VolumeProviderParametersAzureFile](seabreeze-model-volumeproviderparametersazurefile.md) | No |
|
||||
|
||||
____
|
||||
### `description`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
User readable description of the volume.
|
||||
|
||||
____
|
||||
### `provider`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
__Default__: `SFAzureFile` <br/>
|
||||
<br/>
|
||||
Provider of the volume.
|
||||
|
||||
____
|
||||
### `azureFileParameters`
|
||||
__Type__: [VolumeProviderParametersAzureFile](seabreeze-model-volumeproviderparametersazurefile.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
This type describes a volume provided by an Azure Files file share.
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
# VolumeProviderParametersAzureFile
|
||||
|
||||
This type describes a volume provided by an Azure Files file share.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`accountName`](#accountname) | string | Yes |
|
||||
| [`accountKey`](#accountkey) | string | Yes |
|
||||
| [`shareName`](#sharename) | string | Yes |
|
||||
|
||||
____
|
||||
### `accountName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Name of the Azure storage account for the File Share.
|
||||
|
||||
____
|
||||
### `accountKey`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Access key of the Azure storage account for the File Share.
|
||||
|
||||
____
|
||||
### `shareName`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Name of the Azure Files file share that provides storage for the volume.
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
# VolumeResourceDescription
|
||||
|
||||
This type describes a volume resource.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`id`](#id) | string | No |
|
||||
| [`name`](#name) | string | No |
|
||||
| [`type`](#type) | string | No |
|
||||
| [`tags`](#tags) | map of string to string | No |
|
||||
| [`location`](#location) | string | Yes |
|
||||
| [`properties`](#properties) | [VolumeResourceProperties](seabreeze-model-volumeresourceproperties.md) | Yes |
|
||||
|
||||
____
|
||||
### `id`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
||||
|
||||
____
|
||||
### `name`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The name of the resource
|
||||
|
||||
____
|
||||
### `type`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
|
||||
|
||||
____
|
||||
### `tags`
|
||||
__Type__: map of string to string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
Resource tags.
|
||||
|
||||
____
|
||||
### `location`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
The geo-location where the resource lives
|
||||
|
||||
____
|
||||
### `properties`
|
||||
__Type__: [VolumeResourceProperties](seabreeze-model-volumeresourceproperties.md) <br/>
|
||||
__Required__: Yes<br/>
|
||||
<br/>
|
||||
Describes properties of a volume resource.
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
# VolumeResourceDescriptionList
|
||||
|
||||
A pageable list of volume resources.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`value`](#value) | array of [VolumeResourceDescription](seabreeze-model-volumeresourcedescription.md) | No |
|
||||
| [`nextLink`](#nextlink) | string | No |
|
||||
|
||||
____
|
||||
### `value`
|
||||
__Type__: array of [VolumeResourceDescription](seabreeze-model-volumeresourcedescription.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
One page of the list.
|
||||
|
||||
____
|
||||
### `nextLink`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
URI to fetch the next page of the list.
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
# VolumeResourceProperties
|
||||
|
||||
Describes properties of a volume resource.
|
||||
|
||||
## Properties
|
||||
| Name | Type | Required |
|
||||
| --- | --- | --- |
|
||||
| [`provisioningState`](#provisioningstate) | string | No |
|
||||
| [`description`](#description) | string | No |
|
||||
| [`provider`](#provider) | string | Yes |
|
||||
| [`azureFileParameters`](#azurefileparameters) | [VolumeProviderParametersAzureFile](seabreeze-model-volumeproviderparametersazurefile.md) | No |
|
||||
|
||||
____
|
||||
### `provisioningState`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
State of the resource.
|
||||
|
||||
____
|
||||
### `description`
|
||||
__Type__: string <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
User readable description of the volume.
|
||||
|
||||
____
|
||||
### `provider`
|
||||
__Type__: string <br/>
|
||||
__Required__: Yes<br/>
|
||||
__Default__: `SFAzureFile` <br/>
|
||||
<br/>
|
||||
Provider of the volume.
|
||||
|
||||
____
|
||||
### `azureFileParameters`
|
||||
__Type__: [VolumeProviderParametersAzureFile](seabreeze-model-volumeproviderparametersazurefile.md) <br/>
|
||||
__Required__: No<br/>
|
||||
<br/>
|
||||
This type describes a volume provided by an Azure Files file share.
|
||||
|
|
@ -0,0 +1,78 @@
|
|||
# [SeaBreeze APIs](seabreeze-index.md)
|
||||
## [Applications](seabreeze-index-applications.md)
|
||||
### [Create](seabreeze-api-application_create.md)
|
||||
### [Get](seabreeze-api-application_get.md)
|
||||
### [Delete](seabreeze-api-application_delete.md)
|
||||
### [List By Resource Group](seabreeze-api-application_listbyresourcegroup.md)
|
||||
### [List By Subscription](seabreeze-api-application_listbysubscription.md)
|
||||
## [Services](seabreeze-index-services.md)
|
||||
### [List By Application Name](seabreeze-api-service_listbyapplicationname.md)
|
||||
### [Get](seabreeze-api-service_get.md)
|
||||
## [Replicas](seabreeze-index-replicas.md)
|
||||
### [List By Service Name](seabreeze-api-replica_listbyservicename.md)
|
||||
### [Get](seabreeze-api-replica_get.md)
|
||||
## [ContainerLogs](seabreeze-index-containerlogs.md)
|
||||
### [Get Container Log](seabreeze-api-codepackage_getcontainerlog.md)
|
||||
## [Operations](seabreeze-index-operations.md)
|
||||
### [List](seabreeze-api-operations_list.md)
|
||||
## [Networks](seabreeze-index-networks.md)
|
||||
### [Create](seabreeze-api-network_create.md)
|
||||
### [Get](seabreeze-api-network_get.md)
|
||||
### [Delete](seabreeze-api-network_delete.md)
|
||||
### [List By Resource Group](seabreeze-api-network_listbyresourcegroup.md)
|
||||
### [List By Subscription](seabreeze-api-network_listbysubscription.md)
|
||||
## [Volumes](seabreeze-index-volumes.md)
|
||||
### [Create](seabreeze-api-volume_create.md)
|
||||
### [Get](seabreeze-api-volume_get.md)
|
||||
### [Delete](seabreeze-api-volume_delete.md)
|
||||
### [List By Resource Group](seabreeze-api-volume_listbyresourcegroup.md)
|
||||
### [List By Subscription](seabreeze-api-volume_listbysubscription.md)
|
||||
## [Models](seabreeze-index-models.md)
|
||||
### [Resource](seabreeze-model-resource.md)
|
||||
### [ManagedProxyResource](seabreeze-model-managedproxyresource.md)
|
||||
### [ProvisionedResourceProperties](seabreeze-model-provisionedresourceproperties.md)
|
||||
### [Layer4IngressConfig](seabreeze-model-layer4ingressconfig.md)
|
||||
### [IngressConfig](seabreeze-model-ingressconfig.md)
|
||||
### [NetworkResourceProperties](seabreeze-model-networkresourceproperties.md)
|
||||
### [NetworkResourceDescriptionList](seabreeze-model-networkresourcedescriptionlist.md)
|
||||
### [NetworkProperties](seabreeze-model-networkproperties.md)
|
||||
### [VolumeProviderParametersAzureFile](seabreeze-model-volumeproviderparametersazurefile.md)
|
||||
### [VolumeResourceProperties](seabreeze-model-volumeresourceproperties.md)
|
||||
### [VolumeResourceDescriptionList](seabreeze-model-volumeresourcedescriptionlist.md)
|
||||
### [VolumeProperties](seabreeze-model-volumeproperties.md)
|
||||
### [ApplicationResourceProperties](seabreeze-model-applicationresourceproperties.md)
|
||||
### [ApplicationResourceDescriptionList](seabreeze-model-applicationresourcedescriptionlist.md)
|
||||
### [ApplicationProperties](seabreeze-model-applicationproperties.md)
|
||||
### [ServiceList](seabreeze-model-servicelist.md)
|
||||
### [ContainerState](seabreeze-model-containerstate.md)
|
||||
### [ContainerEvent](seabreeze-model-containerevent.md)
|
||||
### [ContainerInstanceView](seabreeze-model-containerinstanceview.md)
|
||||
### [ContainerLogs](seabreeze-model-containerlogs.md)
|
||||
### [ImageRegistryCredential](seabreeze-model-imageregistrycredential.md)
|
||||
### [ResourceLimits](seabreeze-model-resourcelimits.md)
|
||||
### [ResourceRequests](seabreeze-model-resourcerequests.md)
|
||||
### [ResourceRequirements](seabreeze-model-resourcerequirements.md)
|
||||
### [AvailableOperationDisplay](seabreeze-model-availableoperationdisplay.md)
|
||||
### [OperationResult](seabreeze-model-operationresult.md)
|
||||
### [OperationListResult](seabreeze-model-operationlistresult.md)
|
||||
### [ErrorModel](seabreeze-model-errormodel.md)
|
||||
### [EnvironmentVariable](seabreeze-model-environmentvariable.md)
|
||||
### [EndpointProperties](seabreeze-model-endpointproperties.md)
|
||||
### [ContainerVolume](seabreeze-model-containervolume.md)
|
||||
### [ContainerCodePackageProperties](seabreeze-model-containercodepackageproperties.md)
|
||||
### [ServiceReplicaList](seabreeze-model-servicereplicalist.md)
|
||||
### [NetworkRef](seabreeze-model-networkref.md)
|
||||
### [ServiceReplicaProperties](seabreeze-model-servicereplicaproperties.md)
|
||||
### [ProxyResource](seabreeze-model-proxyresource.md)
|
||||
### [TrackedResource](seabreeze-model-trackedresource.md)
|
||||
### [NetworkResourceDescription](seabreeze-model-networkresourcedescription.md)
|
||||
### [VolumeResourceDescription](seabreeze-model-volumeresourcedescription.md)
|
||||
### [ApplicationResourceDescription](seabreeze-model-applicationresourcedescription.md)
|
||||
### [ServiceResourceProperties](seabreeze-model-serviceresourceproperties.md)
|
||||
### [ServiceReplicaDescription](seabreeze-model-servicereplicadescription.md)
|
||||
### [ServiceResourceDescription](seabreeze-model-serviceresourcedescription.md)
|
||||
### [IngressQoSLevel enum](seabreeze-model-ingressqoslevel.md)
|
||||
### [HealthState enum](seabreeze-model-healthstate.md)
|
||||
### [ApplicationResourceStatus enum](seabreeze-model-applicationresourcestatus.md)
|
||||
### [OperatingSystemTypes enum](seabreeze-model-operatingsystemtypes.md)
|
||||
|
||||
|
|
@ -1 +1,45 @@
|
|||
Coming soon!
|
||||
# Service Fabric SeaBreeze REST APIs
|
||||
|
||||
> see https://aka.ms/autorest
|
||||
|
||||
[Service Fabric](http://aka.ms/ServiceFabric) is a distributed systems platform that makes it easy to package, deploy, and manage scalable and reliable micro-services.
|
||||
|
||||
Service Fabric SeaBreeze provides serverless environment for running Service Fabric applications and containers with usage based billing.
|
||||
|
||||
This folder provides the Swagger specification for Service Fabric SeaBreeze APIs.
|
||||
|
||||
## Configuration
|
||||
Following are the settings for using this specification with [AutoRest](https://aka.ms/autorest) tool to validation and optionally generate SDK.
|
||||
|
||||
### Azure Validator Suppressions
|
||||
Suppressed Rule | Reason
|
||||
----------------|--------
|
||||
R2020 RequiredPropertiesMissingInResourceModel | Service is a proxy resource that is managed (created and updated) by including it in the application resource. The name is required for RP to manager those resources. The name is readOnly in the default resource schema so it is not serialized on the wire by AutoRest generated libraries. This is a bug on our RP and should be fixed.
|
||||
R3018 EnumInsteadOfBoolean | The `readOnly` boolean schema is part of Azure Resource Manager common schema.
|
||||
R3026 TrackedResourcePatchOperation | The patch operation is not implemented in the preview APIs.
|
||||
R3026 TrackedResourceListByImmediateParent | There are operations to list the tracked resources by parent. This seems like a issue in the validator.
|
||||
OV108 Example Validations | There are open issues (bugs) in the validator affecting some of the examples and since there is no way to selectively disable the validation for a particular example or paths, all of the example validation is being turned off.
|
||||
OV109 Example Validations | There are open issues (bugs) in the validator affecting some of the examples and since there is no way to selectively disable the validation for a particular example or paths, all of the example validation is being turned off.
|
||||
|
||||
|
||||
|
||||
```yaml
|
||||
openapi-type: arm
|
||||
|
||||
csharp:
|
||||
azure-arm: true
|
||||
license-header: MICROSOFT_MIT_NO_VERSION
|
||||
|
||||
|
||||
model-validator: true
|
||||
semantic-validator: true
|
||||
azure-validator: true
|
||||
directive:
|
||||
suppress:
|
||||
- R3010
|
||||
- R3026
|
||||
- R3018
|
||||
- R2020
|
||||
- OAV108
|
||||
- OAV109
|
||||
```
|
||||
|
|
|
|||
|
|
@ -0,0 +1,63 @@
|
|||
{
|
||||
"parameters": {
|
||||
"subscriptionId": "00000000-0000-0000-0000-000000000000",
|
||||
"resourceGroupName": "sbz_demo",
|
||||
"api-version": "2018-03-01-privatepreview",
|
||||
"applicationName": "helloWorldApp",
|
||||
"applicationResourceDescription": {
|
||||
"properties": {
|
||||
"description": "SeaBreeze HelloWorld Application!",
|
||||
"services": [
|
||||
{
|
||||
"properties": {
|
||||
"osType": "linux",
|
||||
"codePackages": [
|
||||
{
|
||||
"name": "helloWorldCode",
|
||||
"image": "seabreeze/sbz-helloworld:1.0-alpine",
|
||||
"endpoints": [
|
||||
{
|
||||
"name": "helloWorldListener",
|
||||
"port": 80
|
||||
}
|
||||
],
|
||||
"resources": {
|
||||
"requests": {
|
||||
"memoryInGB": 1,
|
||||
"cpu": 1
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"description": "SeaBreeze Hello World Service.",
|
||||
"replicaCount": 1
|
||||
},
|
||||
"name": "helloWorldService"
|
||||
}
|
||||
]
|
||||
},
|
||||
"tags": {},
|
||||
"location": "EastUS"
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "EastUS",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/applications/myHelloWorldApp",
|
||||
"name": "myHelloWorldApp",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Updating",
|
||||
"description": "SeaBreeze HelloWorld Application!",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"helloWorldService"
|
||||
],
|
||||
"status": "Invalid"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
{
|
||||
"parameters": {
|
||||
"subscriptionId": "00000000-0000-0000-0000-000000000000",
|
||||
"api-version": "2018-03-01-privatepreview",
|
||||
"resourceGroupName": "sbz_demo",
|
||||
"applicationName": "helloWorldAppWindows"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
{
|
||||
"parameters": {
|
||||
"subscriptionId": "00000000-0000-0000-0000-000000000000",
|
||||
"resourceGroupName": "sbz_demo",
|
||||
"api-version": "2018-03-01-privatepreview",
|
||||
"applicationName": "demo1"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/applications/helloWorldAppWindows",
|
||||
"name": "helloWorldAppWindows",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"description": "SeaBreeze HelloWorld Application!",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"helloWorldService"
|
||||
],
|
||||
"status": "Ready"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
{
|
||||
"parameters": {
|
||||
"subscriptionId": "00000000-0000-0000-0000-000000000000",
|
||||
"resourceGroupName": "sbz_demo",
|
||||
"api-version": "2018-03-01-privatepreview"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/applications/helloWorldApp",
|
||||
"name": "helloWorldApp",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"description": "SeaBreeze HelloWorld Application!",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"helloWorldService"
|
||||
],
|
||||
"status": "Ready"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/applications/helloWorldAppWindows",
|
||||
"name": "helloWorldAppWindows",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"description": "SeaBreeze HelloWorld Application!",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"helloWorldService"
|
||||
],
|
||||
"status": "Ready"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,175 @@
|
|||
{
|
||||
"parameters": {
|
||||
"subscriptionId": "00000000-0000-0000-0000-000000000000",
|
||||
"api-version": "2018-03-01-privatepreview"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/abhisramvol/providers/Microsoft.ServiceFabric/applications/myappl",
|
||||
"name": "myappl",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"myservice"
|
||||
],
|
||||
"status": "Ready"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/abhisramvol/providers/Microsoft.ServiceFabric/applications/myappw",
|
||||
"name": "myappw",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"myservice"
|
||||
],
|
||||
"status": "Ready"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "EastUS",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/mfussellapp2/providers/Microsoft.ServiceFabric/applications/SbzVoting",
|
||||
"name": "SbzVoting",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"description": "Voting SeaBreeze!",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"VotingWeb",
|
||||
"VotingData"
|
||||
],
|
||||
"status": "Ready"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "EastUS",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/mfussellapp3/providers/Microsoft.ServiceFabric/applications/SbzVoting",
|
||||
"name": "SbzVoting",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"description": "Voting SeaBreeze!",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"VotingWeb",
|
||||
"VotingData"
|
||||
],
|
||||
"status": "Ready"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/applications/helloWorldApp",
|
||||
"name": "helloWorldApp",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"description": "SeaBreeze HelloWorld Application!",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"helloWorldService"
|
||||
],
|
||||
"status": "Ready"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/applications/helloWorldAppWindows",
|
||||
"name": "helloWorldAppWindows",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"description": "SeaBreeze HelloWorld Application!",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"helloWorldService"
|
||||
],
|
||||
"status": "Ready"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sridhar1ResourceGroup/providers/Microsoft.ServiceFabric/applications/privateRegistryExampleApp",
|
||||
"name": "privateRegistryExampleApp",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Updating",
|
||||
"description": "SeaBreeze example application with container deployed from private image registry.",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"helloWorldService"
|
||||
],
|
||||
"status": "Invalid"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sridhar4ResourceGroup/providers/Microsoft.ServiceFabric/applications/SbzVoting",
|
||||
"name": "SbzVoting",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"description": "Voting SeaBreeze!",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"VotingWeb",
|
||||
"VotingData"
|
||||
],
|
||||
"status": "Ready"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sridharResourceGroup/providers/Microsoft.ServiceFabric/applications/privateRegistryExampleApp",
|
||||
"name": "privateRegistryExampleApp",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Updating",
|
||||
"description": "SeaBreeze example application with container deployed from private image registry.",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"helloWorldService"
|
||||
],
|
||||
"status": "Invalid"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/applications",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sridharRG/providers/Microsoft.ServiceFabric/applications/privateRegistryExampleApp",
|
||||
"name": "privateRegistryExampleApp",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Updating",
|
||||
"description": "SeaBreeze example application with container deployed from private image registry.",
|
||||
"healthState": "Ok",
|
||||
"serviceNames": [
|
||||
"helloWorldService"
|
||||
],
|
||||
"status": "Invalid"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
{
|
||||
"parameters": {
|
||||
"subscriptionId": "00000000-0000-0000-0000-000000000000",
|
||||
"resourceGroupName": "sbz_demo",
|
||||
"api-version": "2018-03-01-privatepreview",
|
||||
"applicationName": "sbzDocApp",
|
||||
"serviceName": "sbzDocService",
|
||||
"replicaName": "0",
|
||||
"codePackageName": "sbzDocCode"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"content": " * Running on http://0.0.0.0:8080/ (Press CTRL+C to quit)\n * Downloading style https://assets-cdn.github.com/assets/frameworks-8f281eb0a8d2308ceb36e714ba3c3aec.css\n * Downloading style https://assets-cdn.github.com/assets/github-a698da0d53574b056d3c79ac732d4a70.css\n * Downloading style https://assets-cdn.github.com/assets/site-83dc1f7ebc9c7461fe1eab799b56c4c4.css\n * Cached all downloads in /root/.grip/cache-4.5.2\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET / HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/asset/frameworks-8f281eb0a8d2308ceb36e714ba3c3aec.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/asset/site-83dc1f7ebc9c7461fe1eab799b56c4c4.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/asset/github-a698da0d53574b056d3c79ac732d4a70.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/static/octicons/octicons.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:03] \"GET /__/grip/static/octicons/octicons.woff2?ef21c39f0ca9b1b5116e5eb7ac5eabe6 HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:03] \"GET /__/grip/static/favicon.ico HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:05] \"GET /seabreeze-index.md HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:09] \"GET /seabreeze-api-application_get.md HTTP/1.1\" 200 -\n"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,52 @@
|
|||
{
|
||||
"operationId": "Network_Create",
|
||||
"description": "This example shows how to create a network resource with custom address range and a load balanced public endpoint.",
|
||||
"parameters": {
|
||||
"subscriptionId": "00000000-0000-0000-0000-000000000000",
|
||||
"resourceGroupName": "sbz_demo",
|
||||
"api-version": "2018-03-01-privatepreview",
|
||||
"networkName": "helloWorldNetworkWindows",
|
||||
"networkResourceDescription": {
|
||||
"properties": {
|
||||
"addressPrefix": "10.0.0.4/22",
|
||||
"ingressConfig": {
|
||||
"layer4": [
|
||||
{
|
||||
"publicPort": "80",
|
||||
"applicationName": "helloWorldAppWindows",
|
||||
"serviceName": "helloWorldService",
|
||||
"endpointName": "helloWorldListener"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"location": "eastus"
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"type": "Microsoft.ServiceFabric/networks",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/networks/helloWorldNetworkWindows",
|
||||
"name": "helloWorldNetworkWindows",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Updating",
|
||||
"addressPrefix": "10.0.0.4/22",
|
||||
"ingressConfig": {
|
||||
"qosLevel": "Bronze",
|
||||
"layer4": [
|
||||
{
|
||||
"publicPort": 80,
|
||||
"applicationName": "helloWorldAppWindows",
|
||||
"serviceName": "helloWorldService",
|
||||
"endpointName": "helloWorldListener"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
{
|
||||
"parameters": {
|
||||
"subscriptionId": "00000000-0000-0000-0000-000000000000",
|
||||
"api-version": "2017-11-01-privatepreview",
|
||||
"resourceGroupName": "sbz_demo",
|
||||
"networkName": "helloWorldNetworkWindows"
|
||||
},
|
||||
"responses": {
|
||||
"200": {}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
{
|
||||
"parameters": {
|
||||
"subscriptionId": "00000000-0000-0000-0000-000000000000",
|
||||
"resourceGroupName": "sbz_demo",
|
||||
"api-version": "2018-03-01-privatepreview",
|
||||
"networkName": "helloWorldNetworkWindows"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"type": "Microsoft.ServiceFabric/networks",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/networks/helloWorldNetworkWindows",
|
||||
"name": "helloWorldNetworkWindows",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"addressPrefix": "10.0.0.4/22",
|
||||
"ingressConfig": {
|
||||
"qosLevel": "Bronze",
|
||||
"publicIPAddress": "52.191.255.103",
|
||||
"layer4": [
|
||||
{
|
||||
"publicPort": 80,
|
||||
"applicationName": "helloWorldAppWindows",
|
||||
"serviceName": "helloWorldService",
|
||||
"endpointName": "helloWorldListener"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,61 @@
|
|||
{
|
||||
"parameters": {
|
||||
"subscriptionId": "00000000-0000-0000-0000-000000000000",
|
||||
"resourceGroupName": "sbz_demo",
|
||||
"api-version": "2018-03-01-privatepreview"
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"body": {
|
||||
"value": [
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/networks",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/networks/helloWorldNetwork",
|
||||
"name": "helloWorldNetwork",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"addressPrefix": "10.0.0.4/22",
|
||||
"ingressConfig": {
|
||||
"qosLevel": "Bronze",
|
||||
"publicIPAddress": "52.191.12.219",
|
||||
"layer4": [
|
||||
{
|
||||
"publicPort": 80,
|
||||
"applicationName": "helloWorldApp",
|
||||
"serviceName": "helloWorldService",
|
||||
"endpointName": "helloWorldListener"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Microsoft.ServiceFabric/networks",
|
||||
"location": "eastus",
|
||||
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabric/networks/helloWorldNetworkWindows",
|
||||
"name": "helloWorldNetworkWindows",
|
||||
"tags": {},
|
||||
"properties": {
|
||||
"provisioningState": "Succeeded",
|
||||
"addressPrefix": "10.0.0.4/22",
|
||||
"ingressConfig": {
|
||||
"qosLevel": "Bronze",
|
||||
"publicIPAddress": "52.191.255.103",
|
||||
"layer4": [
|
||||
{
|
||||
"publicPort": 80,
|
||||
"applicationName": "helloWorldAppWindows",
|
||||
"serviceName": "helloWorldService",
|
||||
"endpointName": "helloWorldListener"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше
Загрузка…
Ссылка в новой задаче