Containers - Attach

Service:

Container Instances

API Version:

2021-10-01

Присоединение к выходным данным конкретного экземпляра контейнера.
Присоединение к выходному потоку определенного экземпляра контейнера в указанной группе ресурсов и группе контейнеров.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/attach?api-version=2021-10-01

Параметры URI

Name	In	Required	Type	Description
containerGroupName	path	True	string	Имя группы контейнеров.
containerName	path	True	string	Имя экземпляра контейнера.
resourceGroupName	path	True	string	Имя группы ресурсов.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют Microsoft Azure подписке. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API клиента

Ответы

Name	Type	Description
200 OK	ContainerAttachResponse	ОК
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Олицетворение учетной записи пользователя

Примеры

ContainerAttach

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1/containers/container1/attach?api-version=2021-10-01

Java

import com.azure.core.util.Context;

/** Samples for Containers Attach. */
public final class Main {
    /*
     * x-ms-original-file: specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2021-10-01/examples/ContainerAttach.json
     */
    /**
     * Sample code: ContainerAttach.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void containerAttach(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .containerGroups()
            .manager()
            .serviceClient()
            .getContainers()
            .attachWithResponse("demo", "demo1", "container1", Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

Go

package armcontainerinstance_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/containerinstance/armcontainerinstance"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2021-10-01/examples/ContainerAttach.json
func ExampleContainersClient_Attach() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armcontainerinstance.NewContainersClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Attach(ctx,
		"demo",
		"demo1",
		"container1",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

const { ContainerInstanceManagementClient } = require("@azure/arm-containerinstance");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Attach to the output stream of a specific container instance in a specified resource group and container group.
 *
 * @summary Attach to the output stream of a specific container instance in a specified resource group and container group.
 * x-ms-original-file: specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2021-10-01/examples/ContainerAttach.json
 */
async function containerAttach() {
  const subscriptionId = "subid";
  const resourceGroupName = "demo";
  const containerGroupName = "demo1";
  const containerName = "container1";
  const credential = new DefaultAzureCredential();
  const client = new ContainerInstanceManagementClient(credential, subscriptionId);
  const result = await client.containers.attach(
    resourceGroupName,
    containerGroupName,
    containerName
  );
  console.log(result);
}

containerAttach().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

200

{
  "webSocketUri": "wss://web-socket-uri",
  "password": "password"
}

Определения

CloudError	Ответ об ошибке службы экземпляра контейнера.
CloudErrorBody	Ответ об ошибке службы экземпляра контейнера.
ContainerAttachResponse	Сведения для выходного потока из подключения контейнера.

CloudError

Ответ об ошибке службы экземпляра контейнера.

Name	Type	Description
error	CloudErrorBody	Ответ об ошибке службы экземпляра контейнера.

CloudErrorBody

Ответ об ошибке службы экземпляра контейнера.

Name	Type	Description
code	string	Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.
details	CloudErrorBody[]	Список дополнительных сведений об ошибке.
message	string	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
target	string	Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

ContainerAttachResponse

Сведения для выходного потока из подключения контейнера.

Name	Type	Description
password	string	Пароль для выходного потока из подключения. Отправка в качестве значения заголовка авторизации при подключении к websocketUri.
webSocketUri	string	Универсальный код ресурса (URI) для выходного потока из подключения.