@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api ContainerInstanceManagementClient
@base https://management.azure.com
@version 2018-10-01
@auth OAuth2
@common_fields {api-version: any # Client API version}
@endpoints 16
@toc subscriptions(15), providers(1)

@group subscriptions
@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/containerGroups
@desc Get a list of container groups in the specified subscription.
@required {subscriptionId: any # Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups
@desc Get a list of container groups in the specified subscription and resource group.
@required {subscriptionId: any # Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # The name of the resource group.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}
@desc Get the properties of the specified container group.
@required {subscriptionId: any # Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # The name of the resource group., containerGroupName: any # The name of the container group.}
@returns(200) OK

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}
@desc Create or update container groups.
@required {subscriptionId: any # Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # The name of the resource group., containerGroupName: any # The name of the container group., containerGroup: any # The properties of the container group to be created or updated.}
@returns(200) OK
@returns(201) Created - the container group is created.

@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}
@desc Update container groups.
@required {subscriptionId: any # Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # The name of the resource group., containerGroupName: any # The name of the container group., Resource: map # The container group resource with just the tags to be updated.}
@returns(200) OK

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}
@desc Delete the specified container group.
@required {subscriptionId: any # Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # The name of the resource group., containerGroupName: any # The name of the container group.}
@returns(200) OK
@returns(204) No Content - the specified container group was not found.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/restart
@desc Restarts all containers in a container group.
@required {subscriptionId: any # Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # The name of the resource group., containerGroupName: any # The name of the container group.}
@returns(204) NoContent

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/stop
@desc Stops all containers in a container group.
@required {subscriptionId: any # Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # The name of the resource group., containerGroupName: any # The name of the container group.}
@returns(204) NoContent

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/start
@desc Starts all containers in a container group.
@required {subscriptionId: any # Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # The name of the resource group., containerGroupName: any # The name of the container group.}
@returns(204) NoContent

@endgroup

@group providers
@endpoint GET /providers/Microsoft.ContainerInstance/operations
@desc List the operations for Azure Container Instance service.
@returns(200) OK

@endgroup

@group subscriptions
@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/usages
@desc Get the usage for a subscription
@required {subscriptionId: any # Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., location: any # The identifier for the physical azure location.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/logs
@desc Get the logs for a specified container instance.
@required {subscriptionId: any # Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # The name of the resource group., containerGroupName: any # The name of the container group., containerName: any # The name of the container instance.}
@optional {tail: any # The number of lines to show from the tail of the container instance log. If not provided, all available logs are shown up to 4mb.}
@returns(200) OK

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/exec
@desc Executes a command in a specific container instance.
@required {subscriptionId: any # Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # The name of the resource group., containerGroupName: any # The name of the container group., containerName: any # The name of the container instance., containerExecRequest: map # The request for the exec command.}
@returns(200) OK

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/providers/Microsoft.ContainerInstance/serviceAssociationLinks/default
@desc Delete the container instance service association link for the subnet.
@required {subscriptionId: any # Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # The name of the resource group., virtualNetworkName: any # The name of the virtual network., subnetName: any # The name of the subnet.}
@returns(200) OK
@returns(204) No Content - the specified service association link was not found.

@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/cachedImages
@desc Get the list of cached images.
@required {subscriptionId: any # Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., location: any # The identifier for the physical azure location.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/capabilities
@desc Get the list of capabilities of the location.
@required {subscriptionId: any # Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., location: any # The identifier for the physical azure location.}
@returns(200) OK

@endgroup

@end
