Esta página fornece informações sobre os clientes e métodos de autenticação com suporte. Ele fornece um código de exemplo que você pode usar para conectar serviços de computação ao Azure OpenAI em Modelos de Fundimento usando o Service Connector. Esta página também lista nomes e valores de variáveis de ambiente padrão que você obteve ao criar as conexões de serviço.
Serviço de computação com suporte
O Conector de Serviço pode ser usado para conectar os seguintes serviços de computação ao Azure OpenAI:
- Serviço de Aplicativo do Azure
- Aplicativos de Contêiner do Azure
- Azure Functions
- AKS (Serviço de Kubernetes do Azure)
- Aplicativos Spring do Azure
Tipos de autenticação e tipos de cliente com suporte
Esta tabela mostra quais combinações de métodos de autenticação e clientes têm suporte para conectar seu serviço de computação ao Azure OpenAI usando o Service Connector. Um "Sim" indica que a combinação tem suporte, enquanto um "Não" indica que não há suporte.
| Tipo de cliente |
Identidade gerenciada atribuída pelo sistema |
Identidade gerenciada atribuída pelo usuário |
Cadeia de conexão/segredo |
Entidade de serviço |
| .NET |
Sim |
Sim |
Sim |
Sim |
| Java |
Sim |
Sim |
Sim |
Sim |
| Node.js |
Sim |
Sim |
Sim |
Sim |
| Python |
Sim |
Sim |
Sim |
Sim |
| Nenhum |
Sim |
Sim |
Sim |
Sim |
Essa tabela indica que todas as combinações de tipos de clientes e métodos de autenticação na tabela têm suporte. Todos os tipos de cliente podem usar qualquer um dos métodos de autenticação para se conectar ao Azure OpenAI usando o Service Connector.
Nomes de variáveis de ambiente padrão ou propriedades de aplicativo e código de exemplo
Use os detalhes de conexão a seguir para conectar os serviços de computação ao Azure OpenAI. Para obter mais informações, consulte a convenção de nomenclatura de configuração.
Identidade gerenciada atribuída pelo sistema
| Nome da variável de ambiente padrão |
Descrição |
Valor de exemplo |
| AZURE_OPENAI_BASE |
Ponto de extremidade do Azure OpenAI |
https://<Azure-OpenAI-name>.openai.azure.com/ |
Código de exemplo
Para se conectar ao Azure OpenAI usando uma identidade gerenciada atribuída pelo sistema, consulte as etapas e o código a seguir.
Instale as dependências.
dotnet add package Azure.AI.OpenAI --prerelease
dotnet add package Azure.Identity
Autentique-se usando a biblioteca de Identidades do Azure e obtenha o ponto de extremidade do Serviço OpenAI do Azure por meio das variáveis de ambiente adicionadas pelo Conector de Serviço. Quando você usa o código a seguir, cancele o comentário da parte do snippet de código para o tipo de autenticação que deseja usar.
using Azure.AI.OpenAI;
using Azure.Identity;
string endpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_BASE");
// Uncomment the following lines corresponding to the authentication type you want to use.
// system-assigned managed identity
// var credential = new DefaultAzureCredential();
// user-assigned managed identity
// var credential = new DefaultAzureCredential(
// new DefaultAzureCredentialOptions
// {
// ManagedIdentityClientId = Environment.GetEnvironmentVariable("AZURE_OPENAI_CLIENTID");
// });
// service principal
// var tenantId = Environment.GetEnvironmentVariable("AZURE_OPENAI_TENANTID");
// var clientId = Environment.GetEnvironmentVariable("AZURE_OPENAI_CLIENTID");
// var clientSecret = Environment.GetEnvironmentVariable("AZURE_OPENAI_CLIENTSECRET");
// var credential = new ClientSecretCredential(tenantId, clientId, clientSecret);
AzureOpenAIClient openAIClient = new(
new Uri(endpoint),
credential
);
Adicione as dependências a seguir no seu arquivo pom.xml:
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-ai-openai</artifactId>
<version>1.0.0-beta.6</version>
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-identity</artifactId>
<version>1.11.4</version>
</dependency>
Autentique-se usando azure-identity e obtenha o ponto de extremidade do Serviço OpenAI do Azure por meio das variáveis de ambiente adicionadas pelo Conector de Serviço. Quando você usa o código a seguir, cancele o comentário da parte do snippet de código para o tipo de autenticação que deseja usar.
// Uncomment the following lines corresponding to the authentication type you want to use.
// for system-managed identity
// DefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();
// for user-assigned managed identity
// DefaultAzureCredential credential = new DefaultAzureCredentialBuilder()
// .managedIdentityClientId(System.getenv("AZURE_OPENAI_CLIENTID"))
// .build();
// for service principal
// ClientSecretCredential credential = new ClientSecretCredentialBuilder()
// .clientId(System.getenv("AZURE_OPENAI_CLIENTID"))
// .clientSecret(System.getenv("AZURE_OPENAI_CLIENTSECRET"))
// .tenantId(System.getenv("AZURE_OPENAI_TENANTID"))
// .build();
String endpoint = System.getenv("AZURE_OPENAI_BASE");
OpenAIClient client = new OpenAIClientBuilder()
.credential(credential)
.endpoint(endpoint)
.buildClient();
Instale as dependências.
pip install openai
pip install azure-identity
Autentique-se usando azure-identity e obtenha o ponto de extremidade do Serviço OpenAI do Azure por meio das variáveis de ambiente adicionadas pelo Conector de Serviço. Quando você usa o código a seguir, cancele o comentário da parte do snippet de código para o tipo de autenticação que deseja usar.
import os
import OpenAI
from azure.identity import ManagedIdentityCredential, ClientSecretCredential, get_bearer_token_provider
# Uncomment the following lines corresponding to the authentication type you want to use.
# system-assigned managed identity
# cred = ManagedIdentityCredential()
# user-assigned managed identity
# managed_identity_client_id = os.getenv('AZURE_OPENAI_CLIENTID')
# cred = ManagedIdentityCredential(client_id=managed_identity_client_id)
# service principal
# tenant_id = os.getenv('AZURE_OPENAI_TENANTID')
# client_id = os.getenv('AZURE_OPENAI_CLIENTID')
# client_secret = os.getenv('AZURE_OPENAI_CLIENTSECRET')
# cred = ClientSecretCredential(tenant_id=tenant_id, client_id=client_id, client_secret=client_secret)
token_provider = get_bearer_token_provider(
cred, "https://cognitiveservices.azure.com/.default"
)
endpoint = os.getenv('AZURE_OPENAI_BASE')
client = AzureOpenAI(
api_version="2024-02-15-preview",
azure_endpoint=endpoint,
azure_ad_token_provider=token_provider
)
Instale as dependências.
npm install --save @azure/identity
npm install @azure/openai
Autentique-se usando @azure/identity e obtenha o ponto de extremidade do Serviço OpenAI do Azure por meio das variáveis de ambiente adicionadas pelo Conector de Serviço. Quando você usa o código a seguir, cancele o comentário da parte do snippet de código para o tipo de autenticação que deseja usar.
import { DefaultAzureCredential,ClientSecretCredential } from "@azure/identity";
// Uncomment the following lines corresponding to the authentication type you want to use.
// for system-assigned managed identity
// const credential = new DefaultAzureCredential();
// for user-assigned managed identity
// const clientId = process.env.AZURE_OPENAI_CLIENTID;
// const credential = new DefaultAzureCredential({
// managedIdentityClientId: clientId
// });
// for service principal
// const tenantId = process.env.AZURE_OPENAI_TENANTID;
// const clientId = process.env.AZURE_OPENAI_CLIENTID;
// const clientSecret = process.env.AZURE_OPENAI_CLIENTSECRET;
// const credential = new ClientSecretCredential(tenantId, clientId, clientSecret);
const endpoint = process.env.AZURE_OPENAI_BASE;
const client = new OpenAIClient(endpoint, credential);
Identidade gerenciada atribuída pelo usuário
| Nome da variável de ambiente padrão |
Descrição |
Valor de exemplo |
| AZURE_OPENAI_BASE |
Ponto de extremidade do OpenAI do Azure |
https://<Azure-OpenAI-name>.openai.azure.com/ |
| AZURE_OPENAI_CLIENTID |
Sua ID de cliente |
<client-ID> |
Código de exemplo
Para se conectar ao Azure OpenAI usando uma identidade gerenciada atribuída pelo usuário, consulte as etapas e o código a seguir.
Instale as dependências.
dotnet add package Azure.AI.OpenAI --prerelease
dotnet add package Azure.Identity
Autentique-se usando a biblioteca de Identidades do Azure e obtenha o ponto de extremidade do Serviço OpenAI do Azure por meio das variáveis de ambiente adicionadas pelo Conector de Serviço. Quando você usa o código a seguir, cancele o comentário da parte do snippet de código para o tipo de autenticação que deseja usar.
using Azure.AI.OpenAI;
using Azure.Identity;
string endpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_BASE");
// Uncomment the following lines corresponding to the authentication type you want to use.
// system-assigned managed identity
// var credential = new DefaultAzureCredential();
// user-assigned managed identity
// var credential = new DefaultAzureCredential(
// new DefaultAzureCredentialOptions
// {
// ManagedIdentityClientId = Environment.GetEnvironmentVariable("AZURE_OPENAI_CLIENTID");
// });
// service principal
// var tenantId = Environment.GetEnvironmentVariable("AZURE_OPENAI_TENANTID");
// var clientId = Environment.GetEnvironmentVariable("AZURE_OPENAI_CLIENTID");
// var clientSecret = Environment.GetEnvironmentVariable("AZURE_OPENAI_CLIENTSECRET");
// var credential = new ClientSecretCredential(tenantId, clientId, clientSecret);
AzureOpenAIClient openAIClient = new(
new Uri(endpoint),
credential
);
Adicione as dependências a seguir no seu arquivo pom.xml:
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-ai-openai</artifactId>
<version>1.0.0-beta.6</version>
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-identity</artifactId>
<version>1.11.4</version>
</dependency>
Autentique-se usando azure-identity e obtenha o ponto de extremidade do Serviço OpenAI do Azure por meio das variáveis de ambiente adicionadas pelo Conector de Serviço. Quando você usa o código a seguir, cancele o comentário da parte do snippet de código para o tipo de autenticação que deseja usar.
// Uncomment the following lines corresponding to the authentication type you want to use.
// for system-managed identity
// DefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();
// for user-assigned managed identity
// DefaultAzureCredential credential = new DefaultAzureCredentialBuilder()
// .managedIdentityClientId(System.getenv("AZURE_OPENAI_CLIENTID"))
// .build();
// for service principal
// ClientSecretCredential credential = new ClientSecretCredentialBuilder()
// .clientId(System.getenv("AZURE_OPENAI_CLIENTID"))
// .clientSecret(System.getenv("AZURE_OPENAI_CLIENTSECRET"))
// .tenantId(System.getenv("AZURE_OPENAI_TENANTID"))
// .build();
String endpoint = System.getenv("AZURE_OPENAI_BASE");
OpenAIClient client = new OpenAIClientBuilder()
.credential(credential)
.endpoint(endpoint)
.buildClient();
Instale as dependências.
pip install openai
pip install azure-identity
Autentique-se usando azure-identity e obtenha o ponto de extremidade do Serviço OpenAI do Azure por meio das variáveis de ambiente adicionadas pelo Conector de Serviço. Quando você usa o código a seguir, cancele o comentário da parte do snippet de código para o tipo de autenticação que deseja usar.
import os
import OpenAI
from azure.identity import ManagedIdentityCredential, ClientSecretCredential, get_bearer_token_provider
# Uncomment the following lines corresponding to the authentication type you want to use.
# system-assigned managed identity
# cred = ManagedIdentityCredential()
# user-assigned managed identity
# managed_identity_client_id = os.getenv('AZURE_OPENAI_CLIENTID')
# cred = ManagedIdentityCredential(client_id=managed_identity_client_id)
# service principal
# tenant_id = os.getenv('AZURE_OPENAI_TENANTID')
# client_id = os.getenv('AZURE_OPENAI_CLIENTID')
# client_secret = os.getenv('AZURE_OPENAI_CLIENTSECRET')
# cred = ClientSecretCredential(tenant_id=tenant_id, client_id=client_id, client_secret=client_secret)
token_provider = get_bearer_token_provider(
cred, "https://cognitiveservices.azure.com/.default"
)
endpoint = os.getenv('AZURE_OPENAI_BASE')
client = AzureOpenAI(
api_version="2024-02-15-preview",
azure_endpoint=endpoint,
azure_ad_token_provider=token_provider
)
Instale as dependências.
npm install --save @azure/identity
npm install @azure/openai
Autentique-se usando @azure/identity e obtenha o ponto de extremidade do Serviço OpenAI do Azure por meio das variáveis de ambiente adicionadas pelo Conector de Serviço. Quando você usa o código a seguir, cancele o comentário da parte do snippet de código para o tipo de autenticação que deseja usar.
import { DefaultAzureCredential,ClientSecretCredential } from "@azure/identity";
// Uncomment the following lines corresponding to the authentication type you want to use.
// for system-assigned managed identity
// const credential = new DefaultAzureCredential();
// for user-assigned managed identity
// const clientId = process.env.AZURE_OPENAI_CLIENTID;
// const credential = new DefaultAzureCredential({
// managedIdentityClientId: clientId
// });
// for service principal
// const tenantId = process.env.AZURE_OPENAI_TENANTID;
// const clientId = process.env.AZURE_OPENAI_CLIENTID;
// const clientSecret = process.env.AZURE_OPENAI_CLIENTSECRET;
// const credential = new ClientSecretCredential(tenantId, clientId, clientSecret);
const endpoint = process.env.AZURE_OPENAI_BASE;
const client = new OpenAIClient(endpoint, credential);
Cadeia de conexão
| Nome da variável de ambiente padrão |
Descrição |
Valor de exemplo |
| AZURE_OPENAI_BASE |
Ponto de extremidade do OpenAI do Azure |
https://<Azure-OpenAI-name>.openai.azure.com/ |
| AZURE_OPENAI_KEY |
Chave de API openai do Azure |
<api-key> |
Exemplo de código
Para se conectar ao Azure OpenAI usando uma cadeia de conexão, consulte as etapas e o código a seguir.
Instale as dependências a seguir.
dotnet add package Azure.AI.OpenAI --prerelease
dotnet add package Azure.Core --version 1.40.0
Obtenha a chave de API e o ponto de extremidade do Serviço OpenAI do Azure por meio das variáveis de ambiente adicionadas pelo Conector de Serviço.
using Azure.AI.OpenAI;
string endpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_BASE")
string key = Environment.GetEnvironmentVariable("AZURE_OPENAI_KEY");
AzureOpenAIClient openAIClient = new(
new Uri(endpoint),
new AzureKeyCredential(key));
Adicione a seguinte dependência em seu arquivo depom.xml :
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-core</artifactId>
<version>1.49.1</version>
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-ai-openai</artifactId>
<version>1.0.0-beta.6</version>
</dependency>
Obtenha a chave de API e o ponto de extremidade do Serviço OpenAI do Azure por meio das variáveis de ambiente adicionadas pelo Conector de Serviço.
String endpoint = System.getenv("AZURE_OPENAI_BASE");
String key = System.getenv("AZURE_OPENAI_KEY");
OpenAIClient client = new OpenAIClientBuilder()
.credential(new AzureKeyCredential(key))
.endpoint(endpoint)
.buildClient();
Instale as dependências a seguir.
pip install openai
pip install azure-core
Obtenha a chave de API e o ponto de extremidade do Serviço OpenAI do Azure por meio das variáveis de ambiente adicionadas pelo Conector de Serviço.
import os
from openai import AzureOpenAI
from azure.core.credentials import AzureKeyCredential
key = os.environ['AZURE_OPENAI_KEY']
endpoint = os.environ['AZURE_OPENAI_BASE']
client = AzureOpenAI(
api_version="2024-02-15-preview",
azure_endpoint=endpoint,
api_key=key
)
Instale as dependências a seguir.
npm install @azure/openai
npm install @azure/core-auth
Obtenha a chave de API e o ponto de extremidade do Serviço OpenAI do Azure por meio das variáveis de ambiente adicionadas pelo Conector de Serviço.
import { OpenAIClient } from "@azure/openai";
import { AzureKeyCredential } from "@azure/core-auth";
const endpoint = process.env.AZURE_OPENAI_BASE;
const credential = new AzureKeyCredential(process.env.AZURE_OPENAI_KEY);
const client = new OpenAIClient(endpoint, credential);
Entidade de serviço
| Nome da variável de ambiente padrão |
Descrição |
Valor de exemplo |
| AZURE_OPENAI_BASE |
Ponto de extremidade do OpenAI do Azure |
https://<Azure-OpenAI-name>.openai.azure.com/ |
| AZURE_OPENAI_CLIENTID |
Sua ID de cliente |
<client-ID> |
| AZURE_OPENAI_CLIENTSECRET |
Seu segredo do cliente |
<client-secret> |
| AZURE_OPENAI_TENANTID |
Sua ID de locatário |
<tenant-ID> |
Código de exemplo
Para se conectar ao Azure OpenAI usando uma entidade de serviço, consulte as etapas e o código a seguir.
Instale as dependências.
dotnet add package Azure.AI.OpenAI --prerelease
dotnet add package Azure.Identity
Autentique-se usando a biblioteca de Identidades do Azure e obtenha o ponto de extremidade do Serviço OpenAI do Azure por meio das variáveis de ambiente adicionadas pelo Conector de Serviço. Quando você usa o código a seguir, cancele o comentário da parte do snippet de código para o tipo de autenticação que deseja usar.
using Azure.AI.OpenAI;
using Azure.Identity;
string endpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_BASE");
// Uncomment the following lines corresponding to the authentication type you want to use.
// system-assigned managed identity
// var credential = new DefaultAzureCredential();
// user-assigned managed identity
// var credential = new DefaultAzureCredential(
// new DefaultAzureCredentialOptions
// {
// ManagedIdentityClientId = Environment.GetEnvironmentVariable("AZURE_OPENAI_CLIENTID");
// });
// service principal
// var tenantId = Environment.GetEnvironmentVariable("AZURE_OPENAI_TENANTID");
// var clientId = Environment.GetEnvironmentVariable("AZURE_OPENAI_CLIENTID");
// var clientSecret = Environment.GetEnvironmentVariable("AZURE_OPENAI_CLIENTSECRET");
// var credential = new ClientSecretCredential(tenantId, clientId, clientSecret);
AzureOpenAIClient openAIClient = new(
new Uri(endpoint),
credential
);
Adicione as dependências a seguir no seu arquivo pom.xml:
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-ai-openai</artifactId>
<version>1.0.0-beta.6</version>
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-identity</artifactId>
<version>1.11.4</version>
</dependency>
Autentique-se usando azure-identity e obtenha o ponto de extremidade do Serviço OpenAI do Azure por meio das variáveis de ambiente adicionadas pelo Conector de Serviço. Quando você usa o código a seguir, cancele o comentário da parte do snippet de código para o tipo de autenticação que deseja usar.
// Uncomment the following lines corresponding to the authentication type you want to use.
// for system-managed identity
// DefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();
// for user-assigned managed identity
// DefaultAzureCredential credential = new DefaultAzureCredentialBuilder()
// .managedIdentityClientId(System.getenv("AZURE_OPENAI_CLIENTID"))
// .build();
// for service principal
// ClientSecretCredential credential = new ClientSecretCredentialBuilder()
// .clientId(System.getenv("AZURE_OPENAI_CLIENTID"))
// .clientSecret(System.getenv("AZURE_OPENAI_CLIENTSECRET"))
// .tenantId(System.getenv("AZURE_OPENAI_TENANTID"))
// .build();
String endpoint = System.getenv("AZURE_OPENAI_BASE");
OpenAIClient client = new OpenAIClientBuilder()
.credential(credential)
.endpoint(endpoint)
.buildClient();
Instale as dependências.
pip install openai
pip install azure-identity
Autentique-se usando azure-identity e obtenha o ponto de extremidade do Serviço OpenAI do Azure por meio das variáveis de ambiente adicionadas pelo Conector de Serviço. Quando você usa o código a seguir, cancele o comentário da parte do snippet de código para o tipo de autenticação que deseja usar.
import os
import OpenAI
from azure.identity import ManagedIdentityCredential, ClientSecretCredential, get_bearer_token_provider
# Uncomment the following lines corresponding to the authentication type you want to use.
# system-assigned managed identity
# cred = ManagedIdentityCredential()
# user-assigned managed identity
# managed_identity_client_id = os.getenv('AZURE_OPENAI_CLIENTID')
# cred = ManagedIdentityCredential(client_id=managed_identity_client_id)
# service principal
# tenant_id = os.getenv('AZURE_OPENAI_TENANTID')
# client_id = os.getenv('AZURE_OPENAI_CLIENTID')
# client_secret = os.getenv('AZURE_OPENAI_CLIENTSECRET')
# cred = ClientSecretCredential(tenant_id=tenant_id, client_id=client_id, client_secret=client_secret)
token_provider = get_bearer_token_provider(
cred, "https://cognitiveservices.azure.com/.default"
)
endpoint = os.getenv('AZURE_OPENAI_BASE')
client = AzureOpenAI(
api_version="2024-02-15-preview",
azure_endpoint=endpoint,
azure_ad_token_provider=token_provider
)
Instale as dependências.
npm install --save @azure/identity
npm install @azure/openai
Autentique-se usando @azure/identity e obtenha o ponto de extremidade do Serviço OpenAI do Azure por meio das variáveis de ambiente adicionadas pelo Conector de Serviço. Quando você usa o código a seguir, cancele o comentário da parte do snippet de código para o tipo de autenticação que deseja usar.
import { DefaultAzureCredential,ClientSecretCredential } from "@azure/identity";
// Uncomment the following lines corresponding to the authentication type you want to use.
// for system-assigned managed identity
// const credential = new DefaultAzureCredential();
// for user-assigned managed identity
// const clientId = process.env.AZURE_OPENAI_CLIENTID;
// const credential = new DefaultAzureCredential({
// managedIdentityClientId: clientId
// });
// for service principal
// const tenantId = process.env.AZURE_OPENAI_TENANTID;
// const clientId = process.env.AZURE_OPENAI_CLIENTID;
// const clientSecret = process.env.AZURE_OPENAI_CLIENTSECRET;
// const credential = new ClientSecretCredential(tenantId, clientId, clientSecret);
const endpoint = process.env.AZURE_OPENAI_BASE;
const client = new OpenAIClient(endpoint, credential);
Conteúdo relacionado