Tenant Configuration - Save
Esta operação cria uma consolidação com o instantâneo de configuração atual para o ramo especificado no repositório. Trata-se de uma operação de execução prolongada e pode demorar vários minutos a concluir.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/save?api-version=2021-08-01
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
configuration
|
path | True |
O identificador da Operação de Configuração do Git. |
|
resource
|
path | True |
string |
O nome do grupo de recursos. |
service
|
path | True |
string |
O nome do serviço Gestão de API. Padrão Regex: |
subscription
|
path | True |
string |
Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço. |
api-version
|
query | True |
string |
Versão da API a utilizar com o pedido de cliente. |
Corpo do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
properties.branch | True |
string |
O nome do ramo git no qual se consolida o instantâneo de configuração atual. |
properties.force |
boolean |
O valor, se for verdadeiro, a base de dados de configuração atual é consolidada no repositório Git, mesmo que o repositório git tenha alterações mais recentes que seriam substituídas. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Resultado da criação de uma consolidação no repositório. |
|
202 Accepted |
Aceite: o cabeçalho de localização contém o URL onde o estado da operação de execução prolongada pode ser verificado. |
|
Other Status Codes |
Resposta de erro que descreve a razão 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
ApiManagementTenantConfigurationSave
Pedido de amostra
Resposta da amostra
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af57d2a6d2e0b688d751b?api-version=2021-08-01
{
"id": "6074e652093a9d0dac3d733c",
"type": "Microsoft.ApiManagement/service/tenant/operationResults",
"name": "6074e652093a9d0dac3d733c",
"properties": {
"status": "Succeeded",
"started": "2021-04-13T00:31:14.94Z",
"updated": "2021-04-13T00:31:27.59Z",
"resultInfo": "The configuration was successfully saved to master as commit c0ae274f6046912107bad734834cbf65918668b6.",
"actionLog": []
}
}
Definições
Name | Description |
---|---|
Async |
Estado de uma operação assíncrona. |
configuration |
O identificador da Operação de Configuração do Git. |
Error |
Contrato de campo de erro. |
Error |
Resposta a Erros. |
Error |
Contrato do Corpo do Erro. |
Operation |
Resultados da Operação Git de Execução Prolongada. |
Operation |
Registo da entidade a ser criada, atualizada ou eliminada. |
Save |
Guarde os detalhes do Contrato de Configuração do Inquilino. |
AsyncOperationStatus
Estado de uma operação assíncrona.
Name | Tipo | Description |
---|---|---|
Failed |
string |
|
InProgress |
string |
|
Started |
string |
|
Succeeded |
string |
configurationIdName
O identificador da Operação de Configuração do Git.
Name | Tipo | Description |
---|---|---|
configuration |
string |
ErrorFieldContract
Contrato de campo de erro.
Name | Tipo | Description |
---|---|---|
code |
string |
Código de erro ao nível da propriedade. |
message |
string |
Representação legível por humanos do erro ao nível da propriedade. |
target |
string |
Nome da propriedade. |
ErrorResponse
Resposta a Erros.
Name | Tipo | Description |
---|---|---|
error.code |
string |
Código de erro definido pelo serviço. Este código serve como um sub-estado para o código de erro HTTP especificado na resposta. |
error.details |
A lista de campos inválidos enviados a pedido, em caso de erro de validação. |
|
error.message |
string |
Representação legível por humanos do erro. |
ErrorResponseBody
Contrato do Corpo do Erro.
Name | Tipo | Description |
---|---|---|
code |
string |
Código de erro definido pelo serviço. Este código serve como um sub-estado para o código de erro HTTP especificado na resposta. |
details |
A lista de campos inválidos enviados a pedido, em caso de erro de validação. |
|
message |
string |
Representação legível por humanos do erro. |
OperationResultContract
Resultados da Operação Git de Execução Prolongada.
Name | Tipo | Description |
---|---|---|
id |
string |
ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
O nome do recurso |
properties.actionLog |
Esta propriedade, se apenas for fornecida como parte da operação de TenantConfiguration_Validate. Contém o registo das entidades que serão atualizadas/criadas/eliminadas como parte da operação de TenantConfiguration_Deploy. |
|
properties.error |
Contrato do Corpo do Erro |
|
properties.id |
string |
Identificador do resultado da operação. |
properties.resultInfo |
string |
Informações de resultados opcionais. |
properties.started |
string |
Hora de início de uma operação assíncrona. A data está em conformidade com o seguinte formato: |
properties.status |
Estado de uma operação assíncrona. |
|
properties.updated |
string |
Hora da última atualização de uma operação assíncrona. A data está em conformidade com o seguinte formato: |
type |
string |
O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
OperationResultLogItemContract
Registo da entidade a ser criada, atualizada ou eliminada.
Name | Tipo | Description |
---|---|---|
action |
string |
Ação como criar/atualizar/eliminar. |
objectKey |
string |
Identificador da entidade que está a ser criada/atualizada/eliminada. |
objectType |
string |
O tipo de contrato de entidade. |
SaveConfigurationParameter
Guarde os detalhes do Contrato de Configuração do Inquilino.
Name | Tipo | Description |
---|---|---|
properties.branch |
string |
O nome do ramo git no qual se consolida o instantâneo de configuração atual. |
properties.force |
boolean |
O valor, se for verdadeiro, a base de dados de configuração atual é consolidada no repositório Git, mesmo que o repositório git tenha alterações mais recentes que seriam substituídas. |