Linkers - Generate Configurations

Referência

Serviço:: Service Connector

Versão da API:: 2022-11-01-preview

Gerar configurações para um Linker.

POST https://management.azure.com/{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}/generateConfigurations?api-version=2022-11-01-preview

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
linkerName	path	True	string	O recurso Linker de nome.
resourceUri	path	True	string	O identificador completamente qualificado do Azure Resource Manager do recurso a ser ligado.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Tipo	Description
action	actionType	Opcional, indique se pretende aplicar configurações na aplicação de origem. Se ativar, gere configurações e aplica-se à aplicação de origem. A predefinição é ativada. Se optar ativamente por Não Participar, não será efetuada nenhuma alteração de configuração na origem.
additionalConfigurations	object	Um dicionário de configurações adicionais a adicionar. O serviço irá gerar automaticamente um conjunto de configurações básicas e esta propriedade destina-se ao preenchimento completo de configurações mais personalizadas
customizedKeys	object	Opcional. Um dicionário de nome de chave predefinido e mapeamento de nome de chave personalizado. Se não for especificado, será utilizado o nome da chave predefinido para gerar configurações
daprProperties	DaprProperties	Indica algumas propriedades adicionais para o tipo de cliente dapr
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indica se deve limpar a operação anterior quando o Linker está a atualizar ou a eliminar

Respostas

Name	Tipo	Description
200 OK	ConfigurationResult	OK. O pedido foi efetuada com êxito.
Other Status Codes	ErrorResponse	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

GenerateConfiguration

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/linkers/linkName/generateConfigurations?api-version=2022-11-01-preview

{
  "customizedKeys": {
    "ASL_DocumentDb_ConnectionString": "MyConnectionstring"
  }
}

from azure.identity import DefaultAzureCredential
from azure.mgmt.servicelinker import ServiceLinkerManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-servicelinker
# USAGE
    python linker_generate_configurations.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ServiceLinkerManagementClient(
        credential=DefaultAzureCredential(),
    )

    response = client.linkers.generate_configurations(
        resource_uri="subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app",
        linker_name="linkName",
    )
    print(response)


# x-ms-original-file: specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2022-11-01-preview/examples/LinkerGenerateConfigurations.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:: 200

{
  "configurations": [
    {
      "name": "MyConnectionstring",
      "value": "ConnectionString"
    }
  ]
}

Definições

Name	Description
actionType	Opcional. Indica a solução de rede pública. Se ativar, ative o acesso à rede pública do serviço de destino com a melhor tentativa. A predefinição é ativada. Se optar ativamente por Não participar, opte ativamente por não participar na configuração de acesso à rede pública.
ConfigurationInfo	As informações de configuração, utilizadas para gerar configurações ou guardar em aplicações
ConfigurationResult	As configurações do recurso de origem incluem appSettings, connectionString e serviceBindings
DaprMetadata	Os metadados do componente dapr.
DaprProperties	Indica algumas propriedades adicionais para o tipo de cliente dapr
DeleteOrUpdateBehavior	O comportamento de limpeza para indicar se a operação de limpeza quando o recurso é eliminado ou atualizado
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
SourceConfiguration	Um item de configuração para o recurso de origem

actionType

Opcional. Indica a solução de rede pública. Se ativar, ative o acesso à rede pública do serviço de destino com a melhor tentativa. A predefinição é ativada. Se optar ativamente por Não participar, opte ativamente por não participar na configuração de acesso à rede pública.

Name	Tipo	Description
enable	string
optOut	string

ConfigurationInfo

As informações de configuração, utilizadas para gerar configurações ou guardar em aplicações

Name	Tipo	Description
action	actionType	Opcional, indique se pretende aplicar configurações na aplicação de origem. Se ativar, gere configurações e aplica-se à aplicação de origem. A predefinição é ativada. Se optar ativamente por Não Participar, não será efetuada nenhuma alteração de configuração na origem.
additionalConfigurations	object	Um dicionário de configurações adicionais a adicionar. O serviço irá gerar automaticamente um conjunto de configurações básicas e esta propriedade destina-se ao preenchimento completo de configurações mais personalizadas
customizedKeys	object	Opcional. Um dicionário de nome de chave predefinido e mapeamento de nome de chave personalizado. Se não for especificado, será utilizado o nome da chave predefinido para gerar configurações
daprProperties	DaprProperties	Indica algumas propriedades adicionais para o tipo de cliente dapr
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indica se deve limpar a operação anterior quando o Linker está a atualizar ou a eliminar

ConfigurationResult

As configurações do recurso de origem incluem appSettings, connectionString e serviceBindings

Name	Tipo	Description
configurations	SourceConfiguration[]	As propriedades de configuração do recurso de origem.

DaprMetadata

Os metadados do componente dapr.

Name	Tipo	Description
name	string	Nome da propriedade de metadados.
secretRef	string	O nome do segredo onde dapr pode obter valor
value	string	Valor da propriedade metadados.

DaprProperties

Indica algumas propriedades adicionais para o tipo de cliente dapr

Name	Tipo	Description
componentType	string	O tipo de componente dapr
metadata	DaprMetadata[]	Metadados dapr adicionais
scopes	string[]	Os âmbitos do componente dapr
secretStoreComponent	string	O nome de um arquivo secreto dapr para obter o segredo
version	string	A versão do componente dapr

DeleteOrUpdateBehavior

O comportamento de limpeza para indicar se a operação de limpeza quando o recurso é eliminado ou atualizado

Name	Tipo	Description
Default	string
ForcedCleanup	string

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

SourceConfiguration

Um item de configuração para o recurso de origem

Name	Tipo	Description
name	string	O nome da definição.
value	string	O valor da definição

Partilhar via