Azure
/
service-fabric-mesh-preview
зеркало из
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

SeaBreeze Resource Provider documentation

This commit is contained in:
Ling Geng 2018-01-20 11:32:30 -08:00
Родитель 97e6fab1e8
Коммит 4e8078813e
57 изменённых файлов: 3782 добавлений и 53 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

25
README.md
Просмотреть файл

@ -1,14 +1,17 @@
# Installation
Install Azure CLI if it is not there, choose according to your OS type:
[Install Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest)
You could alternatively use Cloud Shell. 
az extension remove --name azure-cli-sbz
az extension add --source https://seabreezepreview.blob.core.windows.net/cli/azure_cli_sbz-0.2.0-py2.py3-none-any.whl
# Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
This project has adopted the
[Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information, see the
[Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any
additional questions or comments.

186
doc/seabreeze-api-containergroups_create.md Normal file
Просмотреть файл

@ -0,0 +1,186 @@
---
title: "Create"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# Create
Creates or updates the container group with the specified name and description.
Creates a container group with the specified name and description. If a container group with the same name already exists, then its description are updated to the one indicated in this request.
## Request
| Method | Request URI |
| ------ | ----------- |
| PUT | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/containerGroups/{containerGroupName}?api-version=2017-11-01-privatepreview` |
## Parameters
| Name | Type | Required | Location |
| --- | --- | --- | --- |
| [subscriptionId](#subscriptionid) | string | Yes | Path |
| [resourceGroupName](#resourcegroupname) | string | Yes | Path |
| [containerGroupName](#containergroupname) | string | Yes | Path |
| [api-version](#api-version) | string | Yes | Query |
| [containerGroup](#containergroup) | [ContainerGroupDescription](seabreeze-model-containergroupdescription.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
____
### containerGroupName
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
The identity of the container group.
____
### api-version
__Type__: string <br/>
__Required__: Yes<br/>
__Default__: 2017-11-01-privatepreview <br/>
<br/>
The version of the API. This is a required parameter and it's value must be "2017-11-01-privatepreview".
____
### containerGroup
__Type__: [ContainerGroupDescription](seabreeze-model-containergroupdescription.md) <br/>
__Required__: Yes<br/>
<br/>
The description of the container group to be created or updated.
## Responses
| HTTP Status Code | Description | Response Schema |
| --- | --- | --- |
| 200 (OK) | Ok<br/> | [ContainerGroupDescription](seabreeze-model-containergroupdescription.md) |
| 201 (Created) | Created<br/> | [ContainerGroupDescription](seabreeze-model-containergroupdescription.md) |
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
## Examples
### ContainerGroupsCreateOrUpdate
#### Request
```
PUT https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ServiceFabric/containerGroups/demo1?api-version=2017-11-01-privatepreview
```
##### Body
```json
{
"id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ServiceFabric/containerGroups/demo1",
"location": "west us",
"name": "demo1",
"properties": {
"containers": [
{
"name": "demo1",
"properties": {
"command": null,
"environmentVariables": [],
"image": "nginx",
"instanceView": {},
"ports": [
{
"port": "80"
}
],
"resources": {
"limits": null,
"requests": {
"cpu": "1",
"memoryInGb": "1.5"
}
},
"volumeMounts": null
}
}
],
"imageRegistryCredentials": null,
"ipAddress": {
"type": "Public"
},
"osType": "Linux",
"provisioningState": null,
"restartPolicy": null,
"state": null
},
"resourceGroup": "demo",
"tags": null,
"type": "Microsoft.ServiceFabric/containerGroups"
}
```
#### 200 Response
##### Body
```json
{
"id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ServiceFabric/containerGroups/demo1",
"location": "WestUs",
"name": "demo1",
"properties": {
"containers": [
{
"name": "demo1",
"properties": {
"command": null,
"environmentVariables": [],
"image": "nginx",
"instanceView": null,
"ports": [
{
"port": "80"
}
],
"resources": {
"limits": null,
"requests": {
"cpu": "1",
"memoryInGb": "1.5"
}
},
"volumeMounts": null
}
}
],
"imageRegistryCredentials": null,
"ipAddress": {
"ip": "10.0.0.1",
"ports": [
{
"port": "80",
"protocol": "TCP"
}
]
},
"osType": "Linux",
"provisioningState": "Succeeded",
"restartPolicy": null,
"state": null,
"volumes": null
},
"resourceGroup": "demo",
"tags": null,
"type": "Microsoft.ServiceFabric/containerGroups"
}
```

81
doc/seabreeze-api-containergroups_delete.md Normal file
Просмотреть файл

@ -0,0 +1,81 @@
---
title: "Delete"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# Delete
Deletes the specified container group.
Deletes the container group identified by the name.
## Request
| Method | Request URI |
| ------ | ----------- |
| DELETE | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/containerGroups/{containerGroupName}?api-version=2017-11-01-privatepreview` |
## Parameters
| Name | Type | Required | Location |
| --- | --- | --- | --- |
| [subscriptionId](#subscriptionid) | string | Yes | Path |
| [resourceGroupName](#resourcegroupname) | string | Yes | Path |
| [containerGroupName](#containergroupname) | 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
____
### containerGroupName
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
The identity of the container group.
____
### api-version
__Type__: string <br/>
__Required__: Yes<br/>
__Default__: 2017-11-01-privatepreview <br/>
<br/>
The version of the API. This is a required parameter and it's value must be "2017-11-01-privatepreview".
## Responses
| HTTP Status Code | Description | Response Schema |
| --- | --- | --- |
| 200 (OK) | OK<br/> | |
| 204 (NoContent) | No Content - the specified container group was not found.<br/> | |
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
## Examples
### ContainerGroupsDelete
#### Request
```
DELETE https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ServiceFabric/containerGroups/demo1?api-version=2017-11-01-privatepreview
```
#### 200 Response
##### Body
The response body is empty.

153
doc/seabreeze-api-containergroups_get.md Normal file
Просмотреть файл

@ -0,0 +1,153 @@
---
title: "Get"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# Get
Gets the container group with the given name.
Gets the container group with the given name. This includes the information about all the containers and its properties.
## Request
| Method | Request URI |
| ------ | ----------- |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/containerGroups/{containerGroupName}?api-version=2017-11-01-privatepreview` |
## Parameters
| Name | Type | Required | Location |
| --- | --- | --- | --- |
| [subscriptionId](#subscriptionid) | string | Yes | Path |
| [resourceGroupName](#resourcegroupname) | string | Yes | Path |
| [containerGroupName](#containergroupname) | 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
____
### containerGroupName
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
The identity of the container group.
____
### api-version
__Type__: string <br/>
__Required__: Yes<br/>
__Default__: 2017-11-01-privatepreview <br/>
<br/>
The version of the API. This is a required parameter and it's value must be "2017-11-01-privatepreview".
## Responses
| HTTP Status Code | Description | Response Schema |
| --- | --- | --- |
| 200 (OK) | OK<br/> | [ContainerGroupDescription](seabreeze-model-containergroupdescription.md) |
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
## Examples
### ContainerGroupsGet
#### Request
```
GET https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ServiceFabric/containerGroups/demo1?api-version=2017-11-01-privatepreview
```
#### 200 Response
##### Body
```json
{
"id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ServiceFabric/containerGroups/demo1",
"location": "WestUs",
"name": "demo1",
"properties": {
"containers": [
{
"name": "demo1",
"properties": {
"command": null,
"environmentVariables": [],
"image": "nginx",
"instanceView": null,
"ports": [
{
"port": "80"
}
],
"resources": {
"limits": null,
"requests": {
"cpu": "1",
"memoryInGb": "1.5"
}
},
"volumeMounts": [
{
"mountPath": "/mnt/volume1",
"name": "volume1",
"readOnly": false
}
]
}
}
],
"imageRegistryCredentials": [
{
"password": null,
"server": "azcloudconsoleregistry.azurecr.io",
"username": "azcloudconsoleregistry"
}
],
"ipAddress": {
"ip": "10.0.0.1",
"ports": [
{
"port": "80",
"protocol": "TCP"
}
]
},
"osType": "Linux",
"provisioningState": "Succeeded",
"restartPolicy": null,
"state": null,
"volumes": [
{
"azureFile": {
"readOnly": null,
"shareName": "share1",
"storageAccountKey": null,
"storageAccountName": "stroage1"
},
"name": "volume1"
}
]
},
"resourceGroup": "demo",
"tags": null,
"type": "Microsoft.ServiceFabric/containerGroups"
}
```

141
doc/seabreeze-api-containergroups_listbyresourcegroup.md Normal file
Просмотреть файл

@ -0,0 +1,141 @@
---
title: "Listby Resource Group"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# Listby Resource Group
Get a list of containers group in the specified resource group.
Get a list of containers and the properties of the container group in the specified resourceGroup.
## Request
| Method | Request URI |
| ------ | ----------- |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/containerGroups?api-version=2017-11-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__: 2017-11-01-privatepreview <br/>
<br/>
The version of the API. This is a required parameter and it's value must be "2017-11-01-privatepreview".
## Responses
| HTTP Status Code | Description | Response Schema |
| --- | --- | --- |
| 200 (OK) | OK<br/> | [ContainerGroupDescriptionList](seabreeze-model-containergroupdescriptionlist.md) |
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
## Examples
### ContainerGroupInstancesList
#### Request
```
GET https://management.azure.com/subscriptions/subid/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/containerGroups?api-version=2017-11-01-privatepreview
```
#### 200 Response
##### Body
```json
{
"value": [
{
"id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ServiceFabric/containerGroups/demo1",
"location": "WestUs",
"name": "demo1",
"properties": {
"containers": [
{
"name": "demo1",
"properties": {
"command": null,
"environmentVariables": [],
"image": "nginx",
"instanceView": null,
"ports": [
{
"port": "80"
}
],
"resources": {
"limits": null,
"requests": {
"cpu": "1",
"memoryInGb": "1.5"
}
},
"volumeMounts": [
{
"mountPath": "/mnt/volume1",
"name": "volume1",
"readOnly": false
}
]
}
}
],
"imageRegistryCredentials": [
{
"password": null,
"server": "azcloudconsoleregistry.azurecr.io",
"username": "azcloudconsoleregistry"
}
],
"ipAddress": {
"ip": "10.0.0.1",
"ports": [
{
"port": "80",
"protocol": "TCP"
}
]
},
"osType": "Linux",
"provisioningState": "Succeeded",
"restartPolicy": null,
"state": null,
"volumes": [
{
"azureFile": {
"readOnly": null,
"shareName": "share1",
"storageAccountKey": null,
"storageAccountName": "stroage1"
},
"name": "volume1"
}
]
},
"resourceGroup": "demo",
"tags": null,
"type": "Microsoft.ServiceFabric/containerGroups"
}
]
}
```

141
doc/seabreeze-api-containergroups_listbysubscription.md Normal file
Просмотреть файл

@ -0,0 +1,141 @@
---
title: "List By Subscription"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# List By Subscription
Get a list of containers group in the specified subscription.
Get a list of containers and the properties of the container group in the specified subscription.
## Request
| Method | Request URI |
| ------ | ----------- |
| GET | `/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/containerGroups?api-version=2017-11-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__: 2017-11-01-privatepreview <br/>
<br/>
The version of the API. This is a required parameter and it's value must be "2017-11-01-privatepreview".
## Responses
| HTTP Status Code | Description | Response Schema |
| --- | --- | --- |
| 200 (OK) | OK<br/> | [ContainerGroupDescriptionList](seabreeze-model-containergroupdescriptionlist.md) |
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
## Examples
### ContainerGroupInstancesList
#### Request
```
GET https://management.azure.com/subscriptions/subid/providers/Microsoft.ServiceFabric/containerGroups?api-version=2017-11-01-privatepreview
```
#### 200 Response
##### Body
```json
{
"value": [
{
"id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ServiceFabric/containerGroups/demo1",
"location": "WestUs",
"name": "demo1",
"properties": {
"containers": [
{
"name": "demo1",
"properties": {
"command": null,
"environmentVariables": [],
"image": "nginx",
"instanceView": null,
"ports": [
{
"port": "80"
}
],
"resources": {
"limits": null,
"requests": {
"cpu": "1",
"memoryInGb": "1.5"
}
},
"volumeMounts": [
{
"mountPath": "/mnt/volume1",
"name": "volume1",
"readOnly": false
}
]
}
}
],
"imageRegistryCredentials": [
{
"password": null,
"server": "azcloudconsoleregistry.azurecr.io",
"username": "azcloudconsoleregistry"
}
],
"ipAddress": {
"ip": "10.0.0.1",
"ports": [
{
"port": "80",
"protocol": "TCP"
}
]
},
"osType": "Linux",
"provisioningState": "Succeeded",
"restartPolicy": null,
"state": null,
"volumes": [
{
"azureFile": {
"readOnly": null,
"shareName": "share1",
"storageAccountKey": null,
"storageAccountName": "stroage1"
},
"name": "volume1"
}
]
},
"resourceGroup": "demo",
"tags": null,
"type": "Microsoft.ServiceFabric/containerGroups"
}
]
}
```

101
doc/seabreeze-api-containergroupscontainerlogs_get.md Normal file
Просмотреть файл

@ -0,0 +1,101 @@
---
title: "Get"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# Get
Get the logs for this container.
## Request
| Method | Request URI |
| ------ | ----------- |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/containerGroups/{containerGroupName}/containers/{containerName}/logs?api-version=2017-11-01-privatepreview&tail={tail}` |
## Parameters
| Name | Type | Required | Location |
| --- | --- | --- | --- |
| [subscriptionId](#subscriptionid) | string | Yes | Path |
| [resourceGroupName](#resourcegroupname) | string | Yes | Path |
| [containerGroupName](#containergroupname) | string | Yes | Path |
| [containerName](#containername) | 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
____
### containerGroupName
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
The identity of the container group.
____
### containerName
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
Container name
____
### api-version
__Type__: string <br/>
__Required__: Yes<br/>
__Default__: 2017-11-01-privatepreview <br/>
<br/>
The version of the API. This is a required parameter and it's value must be "2017-11-01-privatepreview".
____
### tail
__Type__: integer <br/>
__Required__: No<br/>
<br/>
Only show this number of log lines. If not provided, all available logs 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
### ContainerGroupContainerLogsList
#### Request
```
GET https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ServiceFabric/containerGroups/demo1/containers/container1/logs?api-version=2017-11-01-privatepreview&tail=10
```
#### 200 Response
##### Body
```json
{
"content": "log content"
}
```

238
doc/seabreeze-api-containergroupset_create.md Normal file
Просмотреть файл

@ -0,0 +1,238 @@
---
title: "Create"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# Create
Creates or updates the container group set with the specified name and description.
Creates a container group set with the specified name and description. If a container group set with the same name already exists, then its description are updated to the one indicated in this request.
## Request
| Method | Request URI |
| ------ | ----------- |
| PUT | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/containerGroupSets/{containerGroupSetName}?api-version=2017-11-01-privatepreview` |
## Parameters
| Name | Type | Required | Location |
| --- | --- | --- | --- |
| [subscriptionId](#subscriptionid) | string | Yes | Path |
| [resourceGroupName](#resourcegroupname) | string | Yes | Path |
| [containerGroupSetName](#containergroupsetname) | string | Yes | Path |
| [api-version](#api-version) | string | Yes | Query |
| [containerGroupSet](#containergroupset) | [ContainerGroupSetDescription](seabreeze-model-containergroupsetdescription.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
____
### containerGroupSetName
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
The identity of the container group set.
____
### api-version
__Type__: string <br/>
__Required__: Yes<br/>
__Default__: 2017-11-01-privatepreview <br/>
<br/>
The version of the API. This is a required parameter and it's value must be "2017-11-01-privatepreview".
____
### containerGroupSet
__Type__: [ContainerGroupSetDescription](seabreeze-model-containergroupsetdescription.md) <br/>
__Required__: Yes<br/>
<br/>
The description of the container group set to be created or updated.
## Responses
| HTTP Status Code | Description | Response Schema |
| --- | --- | --- |
| 200 (OK) | Ok<br/> | [ContainerGroupSetDescription](seabreeze-model-containergroupsetdescription.md) |
| 201 (Created) | Created<br/> | [ContainerGroupSetDescription](seabreeze-model-containergroupsetdescription.md) |
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
## Examples
### ContainerGroupSetCreateOrUpdate
#### Request
```
PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ServiceFabric/containerGroupSets/demo1?api-version=2017-11-01-privatepreview
```
##### Body
```json
{
"containerGroups": {
"properties": {
"containers": [
{
"name": "FE",
"properties": {
"command": null,
"environmentVariables": [],
"image": "nginx",
"instanceView": null,
"ports": [
{
"port": "80"
}
],
"resources": {
"limits": null,
"requests": {
"cpu": "1",
"memoryInGb": "1.5"
}
},
"volumeMounts": [
{
"mountPath": "/mnt/volume1",
"name": "volume1",
"readOnly": false
}
]
}
}
],
"imageRegistryCredentials": [
{
"password": null,
"server": "azcloudconsoleregistry.azurecr.io",
"username": "azcloudconsoleregistry"
}
],
"ipAddress": {
"ip": "10.0.0.1",
"ports": [
{
"port": "80",
"protocol": "TCP"
}
]
},
"osType": "Linux",
"restartPolicy": null,
"state": null,
"volumes": [
{
"azureFile": {
"readOnly": null,
"shareName": "share1",
"storageAccountKey": null,
"storageAccountName": "stroage1"
},
"name": "volume1"
}
]
}
},
"instanceCount": "1"
}
```
#### 200 Response
##### Body
```json
{
"id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ServiceFabric/containerGroupSets/demo1",
"location": "WestUs",
"name": "demo1",
"provisioningState": "succeeded",
"ContainerGroups": {
"properties": {
"containers": [
{
"name": "FE",
"properties": {
"command": null,
"environmentVariables": [],
"image": "nginx",
"instanceView": null,
"ports": [
{
"port": "80"
}
],
"resources": {
"limits": null,
"requests": {
"cpu": "1",
"memoryInGb": "1.5"
}
},
"volumeMounts": [
{
"mountPath": "/mnt/volume1",
"name": "volume1",
"readOnly": false
}
]
}
}
],
"imageRegistryCredentials": [
{
"password": null,
"server": "azcloudconsoleregistry.azurecr.io",
"username": "azcloudconsoleregistry"
}
],
"ipAddress": {
"ip": "10.0.0.1",
"ports": [
{
"port": "80",
"protocol": "TCP"
}
]
},
"osType": "Linux",
"restartPolicy": null,
"state": null,
"volumes": [
{
"azureFile": {
"readOnly": null,
"shareName": "share1",
"storageAccountKey": null,
"storageAccountName": "stroage1"
},
"name": "volume1"
}
]
}
},
"containerGroupInstanceNames": [
"demo1_0"
],
"instanceCount": "1",
"resourceGroup": "demo",
"type": "Microsoft.ServiceFabric/containerGroupSets"
}
```

81
doc/seabreeze-api-containergroupset_delete.md Normal file
Просмотреть файл

@ -0,0 +1,81 @@
---
title: "Delete"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# Delete
Deletes the specified container group set.
Deletes the container group set identified by the name.
## Request
| Method | Request URI |
| ------ | ----------- |
| DELETE | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/containerGroupSets/{containerGroupSetName}?api-version=2017-11-01-privatepreview` |
## Parameters
| Name | Type | Required | Location |
| --- | --- | --- | --- |
| [subscriptionId](#subscriptionid) | string | Yes | Path |
| [resourceGroupName](#resourcegroupname) | string | Yes | Path |
| [containerGroupSetName](#containergroupsetname) | 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
____
### containerGroupSetName
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
The identity of the container group set.
____
### api-version
__Type__: string <br/>
__Required__: Yes<br/>
__Default__: 2017-11-01-privatepreview <br/>
<br/>
The version of the API. This is a required parameter and it's value must be "2017-11-01-privatepreview".
## Responses
| HTTP Status Code | Description | Response Schema |
| --- | --- | --- |
| 200 (OK) | OK<br/> | |
| 204 (NoContent) | No Content - the specified container group set was not found.<br/> | |
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
## Examples
### ContainerGroupSetsDelete
#### Request
```
DELETE https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ServiceFabric/containerGroupSets/demo1?api-version=2017-11-01-privatepreview
```
#### 200 Response
##### Body
The response body is empty.

159
doc/seabreeze-api-containergroupset_get.md Normal file
Просмотреть файл

@ -0,0 +1,159 @@
---
title: "Get"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# Get
Gets the container groups in the given container group set.
Gets the container groups in the given container group set. This includes the common properties for all the container group sets and the names of the container group set instances created.
## Request
| Method | Request URI |
| ------ | ----------- |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/containerGroupSets/{containerGroupSetName}?api-version=2017-11-01-privatepreview` |
## Parameters
| Name | Type | Required | Location |
| --- | --- | --- | --- |
| [subscriptionId](#subscriptionid) | string | Yes | Path |
| [resourceGroupName](#resourcegroupname) | string | Yes | Path |
| [containerGroupSetName](#containergroupsetname) | 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
____
### containerGroupSetName
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
The identity of the container group set.
____
### api-version
__Type__: string <br/>
__Required__: Yes<br/>
__Default__: 2017-11-01-privatepreview <br/>
<br/>
The version of the API. This is a required parameter and it's value must be "2017-11-01-privatepreview".
## Responses
| HTTP Status Code | Description | Response Schema |
| --- | --- | --- |
| 200 (OK) | OK<br/> | [ContainerGroupSetDescription](seabreeze-model-containergroupsetdescription.md) |
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
## Examples
### ContainerGroupSetGet
#### Request
```
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ServiceFabric/containerGroupSets/demo1?api-version=2017-11-01-privatepreview
```
#### 200 Response
##### Body
```json
{
"id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ServiceFabric/containerGroupSets/demo1",
"location": "WestUs",
"name": "demo1",
"provisioningState": "",
"ContainerGroups": {
"properties": {
"containers": [
{
"name": "FE",
"properties": {
"command": null,
"environmentVariables": [],
"image": "nginx",
"instanceView": null,
"ports": [
{
"port": "80"
}
],
"resources": {
"limits": null,
"requests": {
"cpu": "1",
"memoryInGb": "1.5"
}
},
"volumeMounts": [
{
"mountPath": "/mnt/volume1",
"name": "volume1",
"readOnly": false
}
]
}
}
],
"imageRegistryCredentials": [
{
"password": null,
"server": "azcloudconsoleregistry.azurecr.io",
"username": "azcloudconsoleregistry"
}
],
"ipAddress": {
"ip": "10.0.0.1",
"ports": [
{
"port": "80",
"protocol": "TCP"
}
]
},
"osType": "Linux",
"provisioningState": "Succeeded",
"restartPolicy": null,
"state": null,
"volumes": [
{
"azureFile": {
"readOnly": null,
"shareName": "share1",
"storageAccountKey": null,
"storageAccountName": "stroage1"
},
"name": "volume1"
}
]
}
},
"containerGroupInstanceNames": [
"demo1_0"
],
"instanceCount": "1",
"resourceGroup": "demo",
"type": "Microsoft.ServiceFabric/containerGroupSets"
}
```

104
doc/seabreeze-api-containergroupsetcontainerlogs_get.md Normal file
Просмотреть файл

@ -0,0 +1,104 @@
---
title: "Get"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# Get
Get the logs for this container.
## Request
| Method | Request URI |
| ------ | ----------- |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/containerGroupSets/{containerGroupSetName}/instances/{containerGroupInstanceName}/containers/{containerName}/logs?api-version=2017-11-01-privatepreview&tail={tail}` |
## Parameters
| Name | Type | Required | Location |
| --- | --- | --- | --- |
| [subscriptionId](#subscriptionid) | string | Yes | Path |
| [resourceGroupName](#resourcegroupname) | string | Yes | Path |
| [containerGroupSetName](#containergroupsetname) | string | Yes | Path |
| [containerGroupInstanceName](#containergroupinstancename) | string | Yes | Path |
| [containerName](#containername) | 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
____
### containerGroupSetName
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
The identity of the container group set.
____
### containerGroupInstanceName
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
The identity of the of the container group.
____
### containerName
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
Container name
____
### api-version
__Type__: string <br/>
__Required__: Yes<br/>
__Default__: 2017-11-01-privatepreview <br/>
<br/>
The version of the API. This is a required parameter and it's value must be "2017-11-01-privatepreview".
____
### tail
__Type__: integer <br/>
__Required__: No<br/>
<br/>
Only show this number of log lines. If not provided, all available logs 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/resRg/providers/Microsoft.ServiceFabric/containerGroupSets/demo1/instances/demo1_0/containers/FE/logs?api-version=2017-11-01-privatepreview
```
#### 200 Response
##### Body
The response body is empty.

161
doc/seabreeze-api-containergroupsetinstance_get.md Normal file
Просмотреть файл

@ -0,0 +1,161 @@
---
title: "Get"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# Get
Gets the properties of the specified container group.
The operation returns the properties of the container group including containers, image registry credentials,
restart policy, IP address type, OS type, state, and volumes.
## Request
| Method | Request URI |
| ------ | ----------- |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/containerGroupSets/{containerGroupSetName}/instances/{containerGroupInstanceName}?api-version=2017-11-01-privatepreview` |
## Parameters
| Name | Type | Required | Location |
| --- | --- | --- | --- |
| [subscriptionId](#subscriptionid) | string | Yes | Path |
| [resourceGroupName](#resourcegroupname) | string | Yes | Path |
| [containerGroupSetName](#containergroupsetname) | string | Yes | Path |
| [containerGroupInstanceName](#containergroupinstancename) | 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
____
### containerGroupSetName
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
The identity of the container group set.
____
### containerGroupInstanceName
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
The identity of the of the container group.
____
### api-version
__Type__: string <br/>
__Required__: Yes<br/>
__Default__: 2017-11-01-privatepreview <br/>
<br/>
The version of the API. This is a required parameter and it's value must be "2017-11-01-privatepreview".
## Responses
| HTTP Status Code | Description | Response Schema |
| --- | --- | --- |
| 200 (OK) | OK<br/> | [ContainerGroupInstanceDescription](seabreeze-model-containergroupinstancedescription.md) |
## Examples
### ContainerGroupInstancesGet
#### Request
```
GET https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ServiceFabric/containerGroupSets/demo1/instances/demo1_0?api-version=2017-11-01-privatepreview
```
#### 200 Response
##### Body
```json
{
"id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ServiceFabric/containerGroupSets/demo1/instances/demo1_0",
"location": "WestUs",
"name": "demo1_0",
"properties": {
"containers": [
{
"name": "demo1",
"properties": {
"command": null,
"environmentVariables": [],
"image": "nginx",
"instanceView": null,
"ports": [
{
"port": "80"
}
],
"resources": {
"limits": null,
"requests": {
"cpu": "1",
"memoryInGb": "1.5"
}
},
"volumeMounts": [
{
"mountPath": "/mnt/volume1",
"name": "volume1",
"readOnly": false
}
]
}
}
],
"imageRegistryCredentials": [
{
"password": null,
"server": "azcloudconsoleregistry.azurecr.io",
"username": "azcloudconsoleregistry"
}
],
"ipAddress": {
"ip": "10.0.0.1",
"ports": [
{
"port": "80",
"protocol": "TCP"
}
]
},
"osType": "Linux",
"provisioningState": "Succeeded",
"restartPolicy": null,
"state": null,
"volumes": [
{
"azureFile": {
"readOnly": null,
"shareName": "share1",
"storageAccountKey": null,
"storageAccountName": "stroage1"
},
"name": "volume1"
}
]
},
"resourceGroup": "demo",
"type": "Microsoft.ServiceFabric/containerGroupSets"
}
```

153
doc/seabreeze-api-containergroupsetinstance_list.md Normal file
Просмотреть файл

@ -0,0 +1,153 @@
---
title: "List"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# List
Gets the properties of all container groups in the container group set.
The operation returns the properties of all the container groups including containers, image registry credentials,
restart policy, IP address type, OS type, state, and volumes.
## Request
| Method | Request URI |
| ------ | ----------- |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/containerGroupSets/{containerGroupSetName}/instances?api-version=2017-11-01-privatepreview` |
## Parameters
| Name | Type | Required | Location |
| --- | --- | --- | --- |
| [subscriptionId](#subscriptionid) | string | Yes | Path |
| [resourceGroupName](#resourcegroupname) | string | Yes | Path |
| [containerGroupSetName](#containergroupsetname) | 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
____
### containerGroupSetName
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
The identity of the container group set.
____
### api-version
__Type__: string <br/>
__Required__: Yes<br/>
__Default__: 2017-11-01-privatepreview <br/>
<br/>
The version of the API. This is a required parameter and it's value must be "2017-11-01-privatepreview".
## Responses
| HTTP Status Code | Description | Response Schema |
| --- | --- | --- |
| 200 (OK) | OK<br/> | [ContainerGroupInstanceDescriptionList](seabreeze-model-containergroupinstancedescriptionlist.md) |
## Examples
### ContainerGroupInstancesGetAll
#### Request
```
GET https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ServiceFabric/containerGroupSets/demo1/instances?api-version=2017-11-01-privatepreview
```
#### 200 Response
##### Body
```json
{
"id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ServiceFabric/containerGroupSets/demo1/instances/demo1_0",
"location": "WestUs",
"name": "demo1_0",
"properties": {
"containers": [
{
"name": "demo1",
"properties": {
"command": null,
"environmentVariables": [],
"image": "nginx",
"instanceView": null,
"ports": [
{
"port": "80"
}
],
"resources": {
"limits": null,
"requests": {
"cpu": "1",
"memoryInGb": "1.5"
}
},
"volumeMounts": [
{
"mountPath": "/mnt/volume1",
"name": "volume1",
"readOnly": false
}
]
}
}
],
"imageRegistryCredentials": [
{
"password": null,
"server": "azcloudconsoleregistry.azurecr.io",
"username": "azcloudconsoleregistry"
}
],
"ipAddress": {
"ip": "10.0.0.1",
"ports": [
{
"port": "80",
"protocol": "TCP"
}
]
},
"osType": "Linux",
"provisioningState": "Succeeded",
"restartPolicy": null,
"state": null,
"volumes": [
{
"azureFile": {
"readOnly": null,
"shareName": "share1",
"storageAccountKey": null,
"storageAccountName": "stroage1"
},
"name": "volume1"
}
]
},
"resourceGroup": "demo",
"type": "Microsoft.ServiceFabric/containerGroupSets"
}
```

151
doc/seabreeze-api-containergroupsets_listbyresourcegroup.md Normal file
Просмотреть файл

@ -0,0 +1,151 @@
---
title: "List By Resource Group"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# List By Resource Group
Gets all the container groups sets in the given resource group.
Gets all the container group sets and its properties in the given resource group.
## Request
| Method | Request URI |
| ------ | ----------- |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/containerGroupSets?api-version=2017-11-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__: 2017-11-01-privatepreview <br/>
<br/>
The version of the API. This is a required parameter and it's value must be "2017-11-01-privatepreview".
## Responses
| HTTP Status Code | Description | Response Schema |
| --- | --- | --- |
| 200 (OK) | OK<br/> | [ContainerGroupSetDescriptionList](seabreeze-model-containergroupsetdescriptionlist.md) |
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
## Examples
### ContainerGroupSetGet
#### Request
```
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ServiceFabric/containerGroupSets?api-version=2017-11-01-privatepreview
```
#### 200 Response
##### Body
```json
{
"id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ServiceFabric/containerGroupSets/demo1",
"location": "WestUs",
"name": "demo1",
"provisioningState": "",
"ContainerGroups": {
"properties": {
"containers": [
{
"name": "FE",
"properties": {
"command": null,
"environmentVariables": [],
"image": "nginx",
"instanceView": null,
"ports": [
{
"port": "80"
}
],
"resources": {
"limits": null,
"requests": {
"cpu": "1",
"memoryInGb": "1.5"
}
},
"volumeMounts": [
{
"mountPath": "/mnt/volume1",
"name": "volume1",
"readOnly": false
}
]
}
}
],
"imageRegistryCredentials": [
{
"password": null,
"server": "azcloudconsoleregistry.azurecr.io",
"username": "azcloudconsoleregistry"
}
],
"ipAddress": {
"ip": "10.0.0.1",
"ports": [
{
"port": "80",
"protocol": "TCP"
}
]
},
"osType": "Linux",
"provisioningState": "Succeeded",
"restartPolicy": null,
"state": null,
"volumes": [
{
"azureFile": {
"readOnly": null,
"shareName": "share1",
"storageAccountKey": null,
"storageAccountName": "stroage1"
},
"name": "volume1"
}
]
}
},
"containerGroupInstanceNames": [
"demo1_0"
],
"instanceCount": "1",
"resourceGroup": "demo",
"type": "Microsoft.ServiceFabric/containerGroupSets"
}
```

143
doc/seabreeze-api-containergroupsets_listbysubscriptionid.md Normal file
Просмотреть файл

@ -0,0 +1,143 @@
---
title: "List By Subscription Id"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# List By Subscription Id
Gets all the container groups sets in the given subscription.
Gets all the container group sets and its properties in the given subscription.
## Request
| Method | Request URI |
| ------ | ----------- |
| GET | `/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/containerGroupSets?api-version=2017-11-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__: 2017-11-01-privatepreview <br/>
<br/>
The version of the API. This is a required parameter and it's value must be "2017-11-01-privatepreview".
## Responses
| HTTP Status Code | Description | Response Schema |
| --- | --- | --- |
| 200 (OK) | OK<br/> | [ContainerGroupSetDescriptionList](seabreeze-model-containergroupsetdescriptionlist.md) |
| All other status codes | Error<br/> | [ErrorModel](seabreeze-model-errormodel.md) |
## Examples
### ContainerGroupSetGet
#### Request
```
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/containerGroupSets?api-version=2017-11-01-privatepreview
```
#### 200 Response
##### Body
```json
{
"id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ServiceFabric/containerGroupSets/demo1",
"location": "WestUs",
"name": "demo1",
"provisioningState": "",
"ContainerGroups": {
"properties": {
"containers": [
{
"name": "FE",
"properties": {
"command": null,
"environmentVariables": [],
"image": "nginx",
"instanceView": null,
"ports": [
{
"port": "80"
}
],
"resources": {
"limits": null,
"requests": {
"cpu": "1",
"memoryInGb": "1.5"
}
},
"volumeMounts": [
{
"mountPath": "/mnt/volume1",
"name": "volume1",
"readOnly": false
}
]
}
}
],
"imageRegistryCredentials": [
{
"password": null,
"server": "azcloudconsoleregistry.azurecr.io",
"username": "azcloudconsoleregistry"
}
],
"ipAddress": {
"ip": "10.0.0.1",
"ports": [
{
"port": "80",
"protocol": "TCP"
}
]
},
"osType": "Linux",
"provisioningState": "Succeeded",
"restartPolicy": null,
"state": null,
"volumes": [
{
"azureFile": {
"readOnly": null,
"shareName": "share1",
"storageAccountKey": null,
"storageAccountName": "stroage1"
},
"name": "volume1"
}
]
}
},
"containerGroupInstanceNames": [
"demo1_0"
],
"instanceCount": "1",
"resourceGroup": "demo",
"type": "Microsoft.ServiceFabric/containerGroupSets"
}
```

42
doc/seabreeze-api-operations_list.md Normal file
Просмотреть файл

@ -0,0 +1,42 @@
---
title: "List"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# List
Lists all of the available ServiceFabric Resource Manager REST API operations.
Lists all the available ServiceFabric Resource Manager REST API operations.
## Request
| Method | Request URI |
| ------ | ----------- |
| GET | `/providers/Microsoft.ServiceFabric/operations?api-version={api-version}` |
## Parameters
| Name | Type | Required | Location |
| --- | --- | --- | --- |
| [api-version](#api-version) | string | Yes | Query |
____
### api-version
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
The version of the ServiceFabric resouce provider api
## 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) |

22
doc/seabreeze-index-containergroups.md Normal file
Просмотреть файл

@ -0,0 +1,22 @@
---
title: "ContainerGroups"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# ContainerGroups APIs
| Name | Description |
| --- | --- |
| [Create](seabreeze-api-containergroups_create.md) | Creates or updates the container group with the specified name and description.<br/> |
| [Get](seabreeze-api-containergroups_get.md) | Gets the container group with the given name.<br/> |
| [Listby Resource Group](seabreeze-api-containergroups_listbyresourcegroup.md) | Get a list of containers group in the specified resource group.<br/> |
| [List By Subscription](seabreeze-api-containergroups_listbysubscription.md) | Get a list of containers group in the specified subscription.<br/> |

28
doc/seabreeze-index-containergroupset.md Normal file
Просмотреть файл

@ -0,0 +1,28 @@
---
title: "ContainerGroupSet"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# ContainerGroupSet APIs
| Name | Description |
| --- | --- |
| [Get](seabreeze-api-containergroupsetinstance_get.md) | Gets the properties of the specified container group.<br/> |
| [List](seabreeze-api-containergroupsetinstance_list.md) | Gets the properties of all container groups in the container group set.<br/> |
| [List By Subscription Id](seabreeze-api-containergroupsets_listbysubscriptionid.md) | Gets all the container groups sets in the given subscription.<br/> |
| [List By Resource Group](seabreeze-api-containergroupsets_listbyresourcegroup.md) | Gets all the container groups sets in the given resource group.<br/> |
| [Get](seabreeze-api-containergroupsetcontainerlogs_get.md) | |
| [Create](seabreeze-api-containergroupset_create.md) | Creates or updates the container group set with the specified name and description.<br/> |
| [Get](seabreeze-api-containergroupset_get.md) | Gets the container groups in the given container group set.<br/> |
| [Delete](seabreeze-api-containergroupset_delete.md) | Deletes the specified container group set.<br/> |
| [Delete](seabreeze-api-containergroups_delete.md) | Deletes the specified container group.<br/> |
| [Get](seabreeze-api-containergroupscontainerlogs_get.md) | |

50
doc/seabreeze-index-models.md Normal file
Просмотреть файл

@ -0,0 +1,50 @@
---
title: "Models"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# Type Models
| Name | Description |
| --- | --- |
| [AvailableOperationDisplay](seabreeze-model-availableoperationdisplay.md) | Operation supported by Service Fabric resource provider<br/> |
| [AzureFileVolume](seabreeze-model-azurefilevolume.md) | The Azure file volume.<br/> |
| [Container](seabreeze-model-container.md) | A container instance.<br/> |
| [ContainerEvent](seabreeze-model-containerevent.md) | A container event.<br/> |
| [ContainerGroupDescription](seabreeze-model-containergroupdescription.md) | Describes a Container group.<br/> |
| [ContainerGroupDescriptionList](seabreeze-model-containergroupdescriptionlist.md) | The container group instance list response that contains the container group properties.<br/> |
| [ContainerGroupInstanceDescription](seabreeze-model-containergroupinstancedescription.md) | Describes a Container group instance.<br/> |
| [ContainerGroupInstanceDescriptionList](seabreeze-model-containergroupinstancedescriptionlist.md) | The container group instance list response that contains the container group properties.<br/> |
| [ContainerGroupProperties](seabreeze-model-containergroupproperties.md) | Describes the properties of a Container group.<br/> |
| [ContainerGroupSetDescription](seabreeze-model-containergroupsetdescription.md) | Describes a Container group set.<br/> |
| [ContainerGroupSetDescriptionList](seabreeze-model-containergroupsetdescriptionlist.md) | The container group set list response that contains the container group set properties.<br/> |
| [ContainerGroupSetProperties](seabreeze-model-containergroupsetproperties.md) | Container group set properties.<br/> |
| [ContainerInstanceView](seabreeze-model-containerinstanceview.md) | Information specific to a container instance.<br/> |
| [ContainerLogs](seabreeze-model-containerlogs.md) | The logs of the container.<br/> |
| [ContainerPort](seabreeze-model-containerport.md) | The container port.<br/> |
| [ContainerProperties](seabreeze-model-containerproperties.md) | The container properties.<br/> |
| [ContainerRestartPolicy enum](seabreeze-model-containerrestartpolicy.md) | Possible values include: 'always'<br/> |
| [ContainerState](seabreeze-model-containerstate.md) | The container state.<br/> |
| [EnvironmentVariable](seabreeze-model-environmentvariable.md) | Environment variable to set within the container.<br/> |
| [ErrorModel](seabreeze-model-errormodel.md) | The error details.<br/> |
| [ImageRegistryCredential](seabreeze-model-imageregistrycredential.md) | Image registry credential.<br/> |
| [IpAddress](seabreeze-model-ipaddress.md) | IP address for the container group.<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) | Available operation list result<br/> |
| [ProxyResource](seabreeze-model-proxyresource.md) | The resource model definition.<br/> |
| [Resource](seabreeze-model-resource.md) | The resource model definition.<br/> |
| [ResourceLimits](seabreeze-model-resourcelimits.md) | The resource limits.<br/> |
| [ResourceRequests](seabreeze-model-resourcerequests.md) | The resource requests.<br/> |
| [ResourceRequirements](seabreeze-model-resourcerequirements.md) | The resource requirements.<br/> |
| [Volume](seabreeze-model-volume.md) | The volume definition for the container group.<br/> |
| [VolumeMount](seabreeze-model-volumemount.md) | The volume mount.<br/> |

19
doc/seabreeze-index-operations.md Normal file
Просмотреть файл

@ -0,0 +1,19 @@
---
title: "Operations"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# Operations APIs
| Name | Description |
| --- | --- |
| [List](seabreeze-api-operations_list.md) | Lists all of the available ServiceFabric Resource Manager REST API operations.<br/> |

91
doc/seabreeze-index.md Normal file
Просмотреть файл

@ -0,0 +1,91 @@
---
title: "SeaBreeze Resource Provider API Reference"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# SeaBreeze Container Group Sets REST API Reference
----
## [ContainerGroupSet APIs](seabreeze-index-containergroupset.md)
| Name | Description |
| --- | --- |
| [Get](seabreeze-api-containergroupsetinstance_get.md) | Gets the properties of the specified container group.<br/> |
| [List](seabreeze-api-containergroupsetinstance_list.md) | Gets the properties of all container groups in the container group set.<br/> |
| [List By Subscription Id](seabreeze-api-containergroupsets_listbysubscriptionid.md) | Gets all the container groups sets in the given subscription.<br/> |
| [List By Resource Group](seabreeze-api-containergroupsets_listbyresourcegroup.md) | Gets all the container groups sets in the given resource group.<br/> |
| [Get](seabreeze-api-containergroupsetcontainerlogs_get.md) | |
| [Create](seabreeze-api-containergroupset_create.md) | Creates or updates the container group set with the specified name and description.<br/> |
| [Get](seabreeze-api-containergroupset_get.md) | Gets the container groups in the given container group set.<br/> |
| [Delete](seabreeze-api-containergroupset_delete.md) | Deletes the specified container group set.<br/> |
| [Delete](seabreeze-api-containergroups_delete.md) | Deletes the specified container group.<br/> |
| [Get](seabreeze-api-containergroupscontainerlogs_get.md) | |
----
## [ContainerGroups APIs](seabreeze-index-containergroups.md)
| Name | Description |
| --- | --- |
| [Create](seabreeze-api-containergroups_create.md) | Creates or updates the container group with the specified name and description.<br/> |
| [Get](seabreeze-api-containergroups_get.md) | Gets the container group with the given name.<br/> |
| [Listby Resource Group](seabreeze-api-containergroups_listbyresourcegroup.md) | Get a list of containers group in the specified resource group.<br/> |
| [List By Subscription](seabreeze-api-containergroups_listbysubscription.md) | Get a list of containers group in the specified subscription.<br/> |
----
## [Operations APIs](seabreeze-index-operations.md)
| Name | Description |
| --- | --- |
| [List](seabreeze-api-operations_list.md) | Lists all of the available ServiceFabric Resource Manager REST API operations.<br/> |
----
## [Models](seabreeze-index-models.md)
| Name | Description |
| --- | --- |
| [AvailableOperationDisplay](seabreeze-model-availableoperationdisplay.md) | Operation supported by Service Fabric resource provider<br/> |
| [AzureFileVolume](seabreeze-model-azurefilevolume.md) | The Azure file volume.<br/> |
| [Container](seabreeze-model-container.md) | A container instance.<br/> |
| [ContainerEvent](seabreeze-model-containerevent.md) | A container event.<br/> |
| [ContainerGroupDescription](seabreeze-model-containergroupdescription.md) | Describes a Container group.<br/> |
| [ContainerGroupDescriptionList](seabreeze-model-containergroupdescriptionlist.md) | The container group instance list response that contains the container group properties.<br/> |
| [ContainerGroupInstanceDescription](seabreeze-model-containergroupinstancedescription.md) | Describes a Container group instance.<br/> |
| [ContainerGroupInstanceDescriptionList](seabreeze-model-containergroupinstancedescriptionlist.md) | The container group instance list response that contains the container group properties.<br/> |
| [ContainerGroupProperties](seabreeze-model-containergroupproperties.md) | Describes the properties of a Container group.<br/> |
| [ContainerGroupSetDescription](seabreeze-model-containergroupsetdescription.md) | Describes a Container group set.<br/> |
| [ContainerGroupSetDescriptionList](seabreeze-model-containergroupsetdescriptionlist.md) | The container group set list response that contains the container group set properties.<br/> |
| [ContainerGroupSetProperties](seabreeze-model-containergroupsetproperties.md) | Container group set properties.<br/> |
| [ContainerInstanceView](seabreeze-model-containerinstanceview.md) | Information specific to a container instance.<br/> |
| [ContainerLogs](seabreeze-model-containerlogs.md) | The logs of the container.<br/> |
| [ContainerPort](seabreeze-model-containerport.md) | The container port.<br/> |
| [ContainerProperties](seabreeze-model-containerproperties.md) | The container properties.<br/> |
| [ContainerRestartPolicy enum](seabreeze-model-containerrestartpolicy.md) | Possible values include: 'always'<br/> |
| [ContainerState](seabreeze-model-containerstate.md) | The container state.<br/> |
| [EnvironmentVariable](seabreeze-model-environmentvariable.md) | Environment variable to set within the container.<br/> |
| [ErrorModel](seabreeze-model-errormodel.md) | The error details.<br/> |
| [ImageRegistryCredential](seabreeze-model-imageregistrycredential.md) | Image registry credential.<br/> |
| [IpAddress](seabreeze-model-ipaddress.md) | IP address for the container group.<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) | Available operation list result<br/> |
| [ProxyResource](seabreeze-model-proxyresource.md) | The resource model definition.<br/> |
| [Resource](seabreeze-model-resource.md) | The resource model definition.<br/> |
| [ResourceLimits](seabreeze-model-resourcelimits.md) | The resource limits.<br/> |
| [ResourceRequests](seabreeze-model-resourcerequests.md) | The resource requests.<br/> |
| [ResourceRequirements](seabreeze-model-resourcerequirements.md) | The resource requirements.<br/> |
| [Volume](seabreeze-model-volume.md) | The volume definition for the container group.<br/> |
| [VolumeMount](seabreeze-model-volumemount.md) | The volume mount.<br/> |

52
doc/seabreeze-model-availableoperationdisplay.md Normal file
Просмотреть файл

@ -0,0 +1,52 @@
---
title: "AvailableOperationDisplay"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# AvailableOperationDisplay
Operation supported by Service Fabric 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/>
The name of the provider.
____
### resource
__Type__: string <br/>
__Required__: No<br/>
<br/>
The resource on which the operation is performed
____
### operation
__Type__: string <br/>
__Required__: No<br/>
<br/>
The operation that can be performed.
____
### description
__Type__: string <br/>
__Required__: No<br/>
<br/>
Operation description

52
doc/seabreeze-model-azurefilevolume.md Normal file
Просмотреть файл

@ -0,0 +1,52 @@
---
title: "AzureFileVolume"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# AzureFileVolume
The Azure file volume.
## Properties
| Name | Type | Required |
| --- | --- | --- |
| [shareName](#sharename) | string | Yes |
| [readOnly](#readonly) | boolean | No |
| [storageAccountName](#storageaccountname) | string | Yes |
| [storageAccountKey](#storageaccountkey) | string | No |
____
### shareName
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
The Azure file share name.
____
### readOnly
__Type__: boolean <br/>
__Required__: No<br/>
<br/>
The flag indicating whether the Azure file volume is read only.
____
### storageAccountName
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
The storage account name to access to the Azure file.
____
### storageAccountKey
__Type__: string <br/>
__Required__: No<br/>
<br/>
The storage account key to access to the Azure file.

36
doc/seabreeze-model-container.md Normal file
Просмотреть файл

@ -0,0 +1,36 @@
---
title: "Container"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# Container
A container instance.
## Properties
| Name | Type | Required |
| --- | --- | --- |
| [name](#name) | string | Yes |
| [properties](#properties) | [ContainerProperties](seabreeze-model-containerproperties.md) | Yes |
____
### name
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
The user-provided name of this container
____
### properties
__Type__: [ContainerProperties](seabreeze-model-containerproperties.md) <br/>
__Required__: Yes<br/>
<br/>
The container properties.

60
doc/seabreeze-model-containerevent.md Normal file
Просмотреть файл

@ -0,0 +1,60 @@
---
title: "ContainerEvent"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# 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.

68
doc/seabreeze-model-containergroupdescription.md Normal file
Просмотреть файл

@ -0,0 +1,68 @@
---
title: "ContainerGroupDescription"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# ContainerGroupDescription
Describes a Container group.
## Properties
| Name | Type | Required |
| --- | --- | --- |
| [id](#id) | string | No |
| [name](#name) | string | No |
| [type](#type) | string | No |
| [location](#location) | string | Yes |
| [tags](#tags) | map of string to string | No |
| [properties](#properties) | [ContainerGroupProperties](seabreeze-model-containergroupproperties.md) | Yes |
____
### id
__Type__: string <br/>
__Required__: No<br/>
<br/>
Azure resource ID.
____
### name
__Type__: string <br/>
__Required__: No<br/>
<br/>
Azure resource name.
____
### type
__Type__: string <br/>
__Required__: No<br/>
<br/>
Azure resource type.
____
### location
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
Resource location.
____
### tags
__Type__: map of string to string <br/>
__Required__: No<br/>
<br/>
Resource tags.
____
### properties
__Type__: [ContainerGroupProperties](seabreeze-model-containergroupproperties.md) <br/>
__Required__: Yes<br/>
<br/>
Describes the properties of a Container group.

36
doc/seabreeze-model-containergroupdescriptionlist.md Normal file
Просмотреть файл

@ -0,0 +1,36 @@
---
title: "ContainerGroupDescriptionList"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# ContainerGroupDescriptionList
The container group instance list response that contains the container group properties.
## Properties
| Name | Type | Required |
| --- | --- | --- |
| [value](#value) | array of [ContainerGroupDescription](seabreeze-model-containergroupdescription.md) | No |
| [nextLink](#nextlink) | string | No |
____
### value
__Type__: array of [ContainerGroupDescription](seabreeze-model-containergroupdescription.md) <br/>
__Required__: No<br/>
<br/>
The list of container group instances.
____
### nextLink
__Type__: string <br/>
__Required__: No<br/>
<br/>
The URI to fetch the next page of container group instances.

60
doc/seabreeze-model-containergroupinstancedescription.md Normal file
Просмотреть файл

@ -0,0 +1,60 @@
---
title: "ContainerGroupInstanceDescription"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# ContainerGroupInstanceDescription
Describes a Container group instance.
## Properties
| Name | Type | Required |
| --- | --- | --- |
| [id](#id) | string | No |
| [name](#name) | string | No |
| [type](#type) | string | No |
| [location](#location) | string | Yes |
| [properties](#properties) | [ContainerGroupProperties](seabreeze-model-containergroupproperties.md) | Yes |
____
### id
__Type__: string <br/>
__Required__: No<br/>
<br/>
Azure resource ID.
____
### name
__Type__: string <br/>
__Required__: No<br/>
<br/>
Azure resource name.
____
### type
__Type__: string <br/>
__Required__: No<br/>
<br/>
Azure resource type.
____
### location
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
Resource location.
____
### properties
__Type__: [ContainerGroupProperties](seabreeze-model-containergroupproperties.md) <br/>
__Required__: Yes<br/>
<br/>
Describes the properties of a Container group.

36
doc/seabreeze-model-containergroupinstancedescriptionlist.md Normal file
Просмотреть файл

@ -0,0 +1,36 @@
---
title: "ContainerGroupInstanceDescriptionList"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# ContainerGroupInstanceDescriptionList
The container group instance list response that contains the container group properties.
## Properties
| Name | Type | Required |
| --- | --- | --- |
| [value](#value) | array of [ContainerGroupInstanceDescription](seabreeze-model-containergroupinstancedescription.md) | No |
| [nextLink](#nextlink) | string | No |
____
### value
__Type__: array of [ContainerGroupInstanceDescription](seabreeze-model-containergroupinstancedescription.md) <br/>
__Required__: No<br/>
<br/>
The list of container group instances.
____
### nextLink
__Type__: string <br/>
__Required__: No<br/>
<br/>
The URI to fetch the next page of container group instances.

83
doc/seabreeze-model-containergroupproperties.md Normal file
Просмотреть файл

@ -0,0 +1,83 @@
---
title: "ContainerGroupProperties"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# ContainerGroupProperties
Describes the properties of a Container group.
## Properties
| Name | Type | Required |
| --- | --- | --- |
| [containers](#containers) | array of [Container](seabreeze-model-container.md) | Yes |
| [imageRegistryCredentials](#imageregistrycredentials) | array of [ImageRegistryCredential](seabreeze-model-imageregistrycredential.md) | No |
| [restartPolicy](#restartpolicy) | string (enum) | No |
| [ipAddress](#ipaddress) | [IpAddress](seabreeze-model-ipaddress.md) | No |
| [osType](#ostype) | string (enum) | Yes |
| [state](#state) | string | No |
| [volumes](#volumes) | array of [Volume](seabreeze-model-volume.md) | No |
____
### containers
__Type__: array of [Container](seabreeze-model-container.md) <br/>
__Required__: Yes<br/>
<br/>
The containers in this container group.
____
### imageRegistryCredentials
__Type__: array of [ImageRegistryCredential](seabreeze-model-imageregistrycredential.md) <br/>
__Required__: No<br/>
<br/>
The image registry credentials by which the container group is created from.
____
### restartPolicy
__Type__: string (enum) <br/>
__Required__: No<br/>
<br/>
- `always` Always restart
____
### ipAddress
__Type__: [IpAddress](seabreeze-model-ipaddress.md) <br/>
__Required__: No<br/>
<br/>
IP address for the container group.
____
### osType
__Type__: string (enum) <br/>
__Required__: Yes<br/>
<br/>
The base level OS type required by the containers in the group.
____
### state
__Type__: string <br/>
__Required__: No<br/>
<br/>
The state of the container group. Only valid in response.
____
### volumes
__Type__: array of [Volume](seabreeze-model-volume.md) <br/>
__Required__: No<br/>
<br/>
The volumes for this container group.

68
doc/seabreeze-model-containergroupsetdescription.md Normal file
Просмотреть файл

@ -0,0 +1,68 @@
---
title: "ContainerGroupSetDescription"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# ContainerGroupSetDescription
Describes a Container group set.
## Properties
| Name | Type | Required |
| --- | --- | --- |
| [id](#id) | string | No |
| [name](#name) | string | No |
| [type](#type) | string | No |
| [location](#location) | string | Yes |
| [tags](#tags) | map of string to string | No |
| [properties](#properties) | [ContainerGroupSetProperties](seabreeze-model-containergroupsetproperties.md) | Yes |
____
### id
__Type__: string <br/>
__Required__: No<br/>
<br/>
Azure resource ID.
____
### name
__Type__: string <br/>
__Required__: No<br/>
<br/>
Azure resource name.
____
### type
__Type__: string <br/>
__Required__: No<br/>
<br/>
Azure resource type.
____
### location
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
Resource location.
____
### tags
__Type__: map of string to string <br/>
__Required__: No<br/>
<br/>
Resource tags.
____
### properties
__Type__: [ContainerGroupSetProperties](seabreeze-model-containergroupsetproperties.md) <br/>
__Required__: Yes<br/>
<br/>
Container group set properties.

36
doc/seabreeze-model-containergroupsetdescriptionlist.md Normal file
Просмотреть файл

@ -0,0 +1,36 @@
---
title: "ContainerGroupSetDescriptionList"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# ContainerGroupSetDescriptionList
The container group set list response that contains the container group set properties.
## Properties
| Name | Type | Required |
| --- | --- | --- |
| [value](#value) | array of [ContainerGroupSetDescription](seabreeze-model-containergroupsetdescription.md) | No |
| [nextLink](#nextlink) | string | No |
____
### value
__Type__: array of [ContainerGroupSetDescription](seabreeze-model-containergroupsetdescription.md) <br/>
__Required__: No<br/>
<br/>
The list of container group sets.
____
### nextLink
__Type__: string <br/>
__Required__: No<br/>
<br/>
The URI to fetch the next page of container group sets.

52
doc/seabreeze-model-containergroupsetproperties.md Normal file
Просмотреть файл

@ -0,0 +1,52 @@
---
title: "ContainerGroupSetProperties"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# ContainerGroupSetProperties
Container group set properties.
## Properties
| Name | Type | Required |
| --- | --- | --- |
| [provisioningState](#provisioningstate) | string | No |
| [containerGroup](#containergroup) | [ContainerGroupProperties](seabreeze-model-containergroupproperties.md) | No |
| [instanceNames](#instancenames) | array of string | No |
| [instanceCount](#instancecount) | integer | No |
____
### provisioningState
__Type__: string <br/>
__Required__: No<br/>
<br/>
The provisioning state, which only appears in the response.
____
### containerGroup
__Type__: [ContainerGroupProperties](seabreeze-model-containergroupproperties.md) <br/>
__Required__: No<br/>
<br/>
The properties of the container groups in this container group set.
____
### instanceNames
__Type__: array of string <br/>
__Required__: No<br/>
<br/>
The names of the container group instances.
____
### instanceCount
__Type__: integer <br/>
__Required__: No<br/>
<br/>
The number of container group instances to create. Defaults to 1 if this parameter is not specified.

52
doc/seabreeze-model-containerinstanceview.md Normal file
Просмотреть файл

@ -0,0 +1,52 @@
---
title: "ContainerInstanceView"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# ContainerInstanceView
Information specific to 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 that 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.

28
doc/seabreeze-model-containerlogs.md Normal file
Просмотреть файл

@ -0,0 +1,28 @@
---
title: "ContainerLogs"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# 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.

28
doc/seabreeze-model-containerport.md Normal file
Просмотреть файл

@ -0,0 +1,28 @@
---
title: "ContainerPort"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# ContainerPort
The container port.
## Properties
| Name | Type | Required |
| --- | --- | --- |
| [port](#port) | integer (int32) | Yes |
____
### port
__Type__: integer (int32) <br/>
__Required__: Yes<br/>
<br/>
Port number to expose within the container group.

76
doc/seabreeze-model-containerproperties.md Normal file
Просмотреть файл

@ -0,0 +1,76 @@
---
title: "ContainerProperties"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# ContainerProperties
The container properties.
## Properties
| Name | Type | Required |
| --- | --- | --- |
| [image](#image) | string | Yes |
| [command](#command) | array of string | No |
| [ports](#ports) | array of [ContainerPort](seabreeze-model-containerport.md) | No |
| [environmentVariables](#environmentvariables) | array of [EnvironmentVariable](seabreeze-model-environmentvariable.md) | No |
| [instanceView](#instanceview) | [ContainerInstanceView](seabreeze-model-containerinstanceview.md) | No |
| [resources](#resources) | [ResourceRequirements](seabreeze-model-resourcerequirements.md) | Yes |
| [volumeMounts](#volumemounts) | array of [VolumeMount](seabreeze-model-volumemount.md) | No |
____
### image
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
The name of the image used when creating this container
____
### command
__Type__: array of string <br/>
__Required__: No<br/>
<br/>
Command array to execute within the container in exec form.
____
### ports
__Type__: array of [ContainerPort](seabreeze-model-containerport.md) <br/>
__Required__: No<br/>
<br/>
The ports exposed by this container
____
### environmentVariables
__Type__: array of [EnvironmentVariable](seabreeze-model-environmentvariable.md) <br/>
__Required__: No<br/>
<br/>
The environment variables to set in this container
____
### instanceView
__Type__: [ContainerInstanceView](seabreeze-model-containerinstanceview.md) <br/>
__Required__: No<br/>
<br/>
Information specific to a container instance.
____
### resources
__Type__: [ResourceRequirements](seabreeze-model-resourcerequirements.md) <br/>
__Required__: Yes<br/>
<br/>
The resource requirements.
____
### volumeMounts
__Type__: array of [VolumeMount](seabreeze-model-volumemount.md) <br/>
__Required__: No<br/>
<br/>
The volume mounts.

19
doc/seabreeze-model-containerrestartpolicy.md Normal file
Просмотреть файл

@ -0,0 +1,19 @@
---
title: "ContainerRestartPolicy"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# ContainerRestartPolicy enum
type: string
Possible values include: 'always'

60
doc/seabreeze-model-containerstate.md Normal file
Просмотреть файл

@ -0,0 +1,60 @@
---
title: "ContainerState"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# ContainerState
The container state.
## Properties
| Name | Type | Required |
| --- | --- | --- |
| [state](#state) | string | No |
| [startTime](#starttime) | string (date-time) | No |
| [exitCode](#exitcode) | integer | 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__: integer <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.

36
doc/seabreeze-model-environmentvariable.md Normal file
Просмотреть файл

@ -0,0 +1,36 @@
---
title: "EnvironmentVariable"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# EnvironmentVariable
Environment variable to set within the container.
## Properties
| Name | Type | Required |
| --- | --- | --- |
| [name](#name) | string | Yes |
| [value](#value) | string | Yes |
____
### name
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
The name of the environment variable.
____
### value
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
The value of the environment variable.

36
doc/seabreeze-model-errormodel.md Normal file
Просмотреть файл

@ -0,0 +1,36 @@
---
title: "ErrorModel"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# 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.

44
doc/seabreeze-model-imageregistrycredential.md Normal file
Просмотреть файл

@ -0,0 +1,44 @@
---
title: "ImageRegistryCredential"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# 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.

45
doc/seabreeze-model-ipaddress.md Normal file
Просмотреть файл

@ -0,0 +1,45 @@
---
title: "IpAddress"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# IpAddress
IP address for the container group.
## Properties
| Name | Type | Required |
| --- | --- | --- |
| [ports](#ports) | array of [ContainerPort](seabreeze-model-containerport.md) | Yes |
| [type](#type) | string | Yes |
| [ip](#ip) | string | No |
____
### ports
__Type__: array of [ContainerPort](seabreeze-model-containerport.md) <br/>
__Required__: Yes<br/>
<br/>
The ports.
____
### type
__Type__: string <br/>
__Required__: Yes<br/>
__Default__: Public <br/>
<br/>
Determines whether the IP is exposed to the public internet.
____
### ip
__Type__: string <br/>
__Required__: No<br/>
<br/>
The IP exposed to the public internet.

19
doc/seabreeze-model-operatingsystemtypes.md Normal file
Просмотреть файл

@ -0,0 +1,19 @@
---
title: "OperatingSystemTypes"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# OperatingSystemTypes enum
type: string
Possible values include: 'Windows', 'Linux'

36
doc/seabreeze-model-operationlistresult.md Normal file
Просмотреть файл

@ -0,0 +1,36 @@
---
title: "OperationListResult"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# 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.

52
doc/seabreeze-model-operationresult.md Normal file
Просмотреть файл

@ -0,0 +1,52 @@
---
title: "OperationResult"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# OperationResult
Available operation list result
## 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.

52
doc/seabreeze-model-proxyresource.md Normal file
Просмотреть файл

@ -0,0 +1,52 @@
---
title: "ProxyResource"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# ProxyResource
The resource model definition.
## Properties
| Name | Type | Required |
| --- | --- | --- |
| [id](#id) | string | No |
| [name](#name) | string | No |
| [type](#type) | string | No |
| [location](#location) | string | Yes |
____
### id
__Type__: string <br/>
__Required__: No<br/>
<br/>
Azure resource ID.
____
### name
__Type__: string <br/>
__Required__: No<br/>
<br/>
Azure resource name.
____
### type
__Type__: string <br/>
__Required__: No<br/>
<br/>
Azure resource type.
____
### location
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
Resource location.

60
doc/seabreeze-model-resource.md Normal file
Просмотреть файл

@ -0,0 +1,60 @@
---
title: "Resource"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# Resource
The resource model definition.
## Properties
| Name | Type | Required |
| --- | --- | --- |
| [id](#id) | string | No |
| [name](#name) | string | No |
| [type](#type) | string | No |
| [location](#location) | string | Yes |
| [tags](#tags) | map of string to string | No |
____
### id
__Type__: string <br/>
__Required__: No<br/>
<br/>
Azure resource ID.
____
### name
__Type__: string <br/>
__Required__: No<br/>
<br/>
Azure resource name.
____
### type
__Type__: string <br/>
__Required__: No<br/>
<br/>
Azure resource type.
____
### location
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
Resource location.
____
### tags
__Type__: map of string to string <br/>
__Required__: No<br/>
<br/>
Resource tags.

36
doc/seabreeze-model-resourcelimits.md Normal file
Просмотреть файл

@ -0,0 +1,36 @@
---
title: "ResourceLimits"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# ResourceLimits
The resource limits.
## 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 of this container.
____
### cpu
__Type__: number (double) <br/>
__Required__: No<br/>
<br/>
The CPU limit of this container.

36
doc/seabreeze-model-resourcerequests.md Normal file
Просмотреть файл

@ -0,0 +1,36 @@
---
title: "ResourceRequests"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# ResourceRequests
The resource requests.
## 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 of this container.
____
### cpu
__Type__: number (double) <br/>
__Required__: Yes<br/>
<br/>
The CPU request of this container.

36
doc/seabreeze-model-resourcerequirements.md Normal file
Просмотреть файл

@ -0,0 +1,36 @@
---
title: "ResourceRequirements"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# ResourceRequirements
The resource requirements.
## 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/>
The resource requests of this container.
____
### limits
__Type__: [ResourceLimits](seabreeze-model-resourcelimits.md) <br/>
__Required__: No<br/>
<br/>
The resource limits of this container.

36
doc/seabreeze-model-volume.md Normal file
Просмотреть файл

@ -0,0 +1,36 @@
---
title: "Volume"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# Volume
The volume definition for the container group.
## Properties
| Name | Type | Required |
| --- | --- | --- |
| [name](#name) | string | Yes |
| [azureFile](#azurefile) | [AzureFileVolume](seabreeze-model-azurefilevolume.md) | Yes |
____
### name
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
The volume name.
____
### azureFile
__Type__: [AzureFileVolume](seabreeze-model-azurefilevolume.md) <br/>
__Required__: Yes<br/>
<br/>
The Azure file volume.

44
doc/seabreeze-model-volumemount.md Normal file
Просмотреть файл

@ -0,0 +1,44 @@
---
title: "VolumeMount"
ms.date: "2018-01-20"
ms.prod: "azure"
ms.service: "SeaBreeze"
ms.topic: "reference"
applies_to:
- "Azure"
dev_langs:
- "rest-api"
helpviewer_keywords:
- "SeaBreeze Resource Provider API Reference"
---
# VolumeMount
The volume mount.
## Properties
| Name | Type | Required |
| --- | --- | --- |
| [name](#name) | string | Yes |
| [mountPath](#mountpath) | Object | Yes |
| [readOnly](#readonly) | boolean | No |
____
### name
__Type__: string <br/>
__Required__: Yes<br/>
<br/>
The volume name.
____
### mountPath
__Type__: Object <br/>
__Required__: Yes<br/>
<br/>
The path with in the container at which the volume should be mounted. Must not contain ':'. type: string
____
### readOnly
__Type__: boolean <br/>
__Required__: No<br/>
<br/>
The flag indicating whether the volume mount is read only.

53
doc/seabreeze-toc.md Normal file
Просмотреть файл

@ -0,0 +1,53 @@
# [SeaBreeze APIs](seabreeze-index.md)
## [ContainerGroupSet](seabreeze-index-containergroupset.md)
### [Get](seabreeze-api-containergroupsetinstance_get.md)
### [List](seabreeze-api-containergroupsetinstance_list.md)
### [List By Subscription Id](seabreeze-api-containergroupsets_listbysubscriptionid.md)
### [List By Resource Group](seabreeze-api-containergroupsets_listbyresourcegroup.md)
### [Get](seabreeze-api-containergroupsetcontainerlogs_get.md)
### [Create](seabreeze-api-containergroupset_create.md)
### [Get](seabreeze-api-containergroupset_get.md)
### [Delete](seabreeze-api-containergroupset_delete.md)
### [Delete](seabreeze-api-containergroups_delete.md)
### [Get](seabreeze-api-containergroupscontainerlogs_get.md)
## [ContainerGroups](seabreeze-index-containergroups.md)
### [Create](seabreeze-api-containergroups_create.md)
### [Get](seabreeze-api-containergroups_get.md)
### [Listby Resource Group](seabreeze-api-containergroups_listbyresourcegroup.md)
### [List By Subscription](seabreeze-api-containergroups_listbysubscription.md)
## [Operations](seabreeze-index-operations.md)
### [List](seabreeze-api-operations_list.md)
## [Models](seabreeze-index-models.md)
### [AzureFileVolume](seabreeze-model-azurefilevolume.md)
### [ContainerPort](seabreeze-model-containerport.md)
### [EnvironmentVariable](seabreeze-model-environmentvariable.md)
### [ContainerState](seabreeze-model-containerstate.md)
### [ContainerEvent](seabreeze-model-containerevent.md)
### [ContainerInstanceView](seabreeze-model-containerinstanceview.md)
### [ResourceRequests](seabreeze-model-resourcerequests.md)
### [ResourceLimits](seabreeze-model-resourcelimits.md)
### [ResourceRequirements](seabreeze-model-resourcerequirements.md)
### [VolumeMount](seabreeze-model-volumemount.md)
### [ContainerProperties](seabreeze-model-containerproperties.md)
### [Container](seabreeze-model-container.md)
### [ImageRegistryCredential](seabreeze-model-imageregistrycredential.md)
### [IpAddress](seabreeze-model-ipaddress.md)
### [Volume](seabreeze-model-volume.md)
### [ContainerGroupProperties](seabreeze-model-containergroupproperties.md)
### [ContainerGroupDescriptionList](seabreeze-model-containergroupdescriptionlist.md)
### [ContainerGroupInstanceDescriptionList](seabreeze-model-containergroupinstancedescriptionlist.md)
### [ContainerGroupSetProperties](seabreeze-model-containergroupsetproperties.md)
### [ContainerGroupSetDescriptionList](seabreeze-model-containergroupsetdescriptionlist.md)
### [ContainerLogs](seabreeze-model-containerlogs.md)
### [Resource](seabreeze-model-resource.md)
### [ProxyResource](seabreeze-model-proxyresource.md)
### [AvailableOperationDisplay](seabreeze-model-availableoperationdisplay.md)
### [OperationResult](seabreeze-model-operationresult.md)
### [OperationListResult](seabreeze-model-operationlistresult.md)
### [ErrorModel](seabreeze-model-errormodel.md)
### [ContainerGroupDescription](seabreeze-model-containergroupdescription.md)
### [ContainerGroupSetDescription](seabreeze-model-containergroupsetdescription.md)
### [ContainerGroupInstanceDescription](seabreeze-model-containergroupinstancedescription.md)
### [ContainerRestartPolicy enum](seabreeze-model-containerrestartpolicy.md)
### [OperatingSystemTypes enum](seabreeze-model-operatingsystemtypes.md)

14
documentation/README.md
Просмотреть файл

@ -1,14 +0,0 @@
# Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

14
documentation/api-reference/README.md
Просмотреть файл

@ -1,14 +0,0 @@
# Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

14
documentation/conceptual-docs/README.md
Просмотреть файл

@ -1,14 +0,0 @@
# Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.