Partilhar via

Api Management Service - Restore

  • Referência
Serviço:
API Management
Versão da API:
2021-08-01

Restaura uma cópia de segurança de um serviço de Gestão de API criado com a operação de ApiManagementService_Backup no serviço atual. Esta é uma operação de execução prolongada e pode demorar vários minutos a ser concluída.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/restore?api-version=2021-08-01

Parâmetros do URI

Name Em Necessário Tipo Description
resourceGroupName
 path True

string

O nome do grupo de recursos.
serviceName
 path True

string

O nome do serviço Gestão de API.

Padrão Regex: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 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
backupName True

string

O nome do ficheiro de cópia de segurança a criar/obter.
containerName True

string

O nome do contentor de blobs (utilizado para colocar/obter a cópia de segurança).
storageAccount True

string

O nome da conta de armazenamento do Azure (utilizada para colocar/obter a cópia de segurança).
accessKey

string

Chave de acesso da conta de armazenamento. Obrigatório apenas se accessType estiver definido como AccessKey.
accessType

AccessType

O tipo de acesso a utilizar para a conta de armazenamento.
clientId

string

O ID de Cliente da identidade gerida atribuída pelo utilizador. Obrigatório apenas se accessType estiver definido como UserAssignedManagedIdentity.

Respostas

Name Tipo Description
200 OK

ApiManagementServiceResource

A cópia de segurança foi restaurada com êxito no serviço Gestão de API.
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

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

ApiManagementRestoreService

Pedido de amostra

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/restore?api-version=2021-08-01

{
  "storageAccount": "teststorageaccount",
  "containerName": "backupContainer",
  "backupName": "apimService1backup_2017_03_19",
  "accessType": "AccessKey",
  "accessKey": "**************************************************"
}

Resposta da amostra

Código de estado:
202 
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2021-08-01
Código de estado:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "West US",
  "etag": "AAAAAAACXok=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-18T06:26:20.3348609Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-westus-01.regional.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": false
      },
      {
        "type": "Proxy",
        "hostName": "gateway1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      }
    ],
    "publicIPAddresses": [
      "13.91.32.113"
    ],
    "additionalLocations": [
      {
        "location": "East US",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "publicIPAddresses": [
          "23.101.138.153"
        ],
        "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net",
        "disableGateway": true
      }
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}

Definições

Name Description
AccessType

O tipo de acesso a utilizar para a conta de armazenamento.
AdditionalLocation

Descrição de uma localização de recursos Gestão de API adicional.
ApiManagementServiceBackupRestoreParameters

Parâmetros fornecidos para a Cópia de Segurança/Restauro de uma operação de serviço Gestão de API.
ApiManagementServiceIdentity

Propriedades de identidade do recurso do serviço de Gestão de Api.
ApiManagementServiceResource

Um único recurso de serviço Gestão de API em Listar ou Obter resposta.
ApiManagementServiceSkuProperties

Gestão de API propriedades do SKU do recurso de serviço.
ApimIdentityType

O tipo de identidade utilizado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá quaisquer identidades do serviço.
ApiVersionConstraint

Restrição da versão das Apis do Plano de Controlo para o serviço Gestão de API.
ArmIdWrapper

Um wrapper para um ID de recurso do ARM
CertificateConfiguration

Configuração do certificado que consiste em intermediários e certificados de raiz não fidedignos.
CertificateInformation

Informações do certificado SSL.
CertificateSource

Origem do Certificado.
CertificateStatus

Estado do Certificado.
createdByType

O tipo de identidade que criou o recurso.
ErrorFieldContract

Contrato de Campo de Erro.
ErrorResponse

Resposta a Erros.
HostnameConfiguration

Configuração personalizada do nome do anfitrião.
HostnameType

Tipo de nome de anfitrião.
PlatformVersion

Versão da Plataforma de Computação a executar o serviço.
PrivateEndpointServiceConnectionStatus

O estado da ligação do ponto final privado.
PrivateLinkServiceConnectionState

Uma coleção de informações sobre o estado da ligação entre o consumidor e o fornecedor do serviço.
PublicNetworkAccess

Se o acesso ao ponto final público é ou não permitido para este serviço de Gestão de API. O valor é opcional, mas, se for transmitido, tem de ser "Ativado" ou "Desativado". Se "Desativado", os pontos finais privados são o método de acesso exclusivo. O valor predefinido é "Ativado"
RemotePrivateEndpointConnectionWrapper

Recurso ligação de ponto final privado remoto.
SkuType

Nome do SKU.
systemData

Metadados relativos à criação e última modificação do recurso.
UserIdentityProperties
VirtualNetworkConfiguration

Configuração de uma rede virtual na qual o serviço Gestão de API é implementado.
VirtualNetworkType

O tipo de VPN na qual Gestão de API serviço tem de ser configurado. Nenhum (Valor Predefinido) significa que o serviço Gestão de API não faz parte de nenhuma Rede Virtual, Externo significa que a implementação Gestão de API está configurada num Rede Virtual ter um Ponto Final Com Acesso à Internet e Interno significa que Gestão de API implementação está configurada dentro de um Rede Virtual ter apenas um Ponto Final Com Acesso à Intranet.

AccessType

O tipo de acesso a utilizar para a conta de armazenamento.

Name Tipo Description
AccessKey

string

Utilize a chave de acesso.
SystemAssignedManagedIdentity

string

Utilizar a identidade gerida atribuída pelo sistema.
UserAssignedManagedIdentity

string

Utilize a identidade gerida atribuída pelo utilizador.

AdditionalLocation

Descrição de uma localização de recursos Gestão de API adicional.

Name Tipo Default value Description
disableGateway

boolean

False

Propriedade apenas válida para um serviço de Gestão de API implementado em várias localizações. Isto pode ser utilizado para desativar o gateway nesta localização adicional.
gatewayRegionalUrl

string

URL do gateway do serviço Gestão de API na Região.
location

string

O nome da localização da região adicional entre as regiões do Datacenter do Azure.
platformVersion

PlatformVersion

Versão da Plataforma de Computação a executar o serviço.
privateIPAddresses

string[]

Endereços IP com Balanceamento de Carga Estático Privado do serviço de Gestão de API que é implementado num Rede Virtual Interno numa localização adicional específica. Disponível apenas para SKU Básico, Standard, Premium e Isolado.
publicIPAddresses

string[]

Endereços IP públicos com Balanceamento de Carga Estático do serviço de Gestão de API na localização adicional. Disponível apenas para SKU Básico, Standard, Premium e Isolado.
publicIpAddressId

string

Endereço IP V4 de IP do SKU Standard Público a ser associado a Rede Virtual serviço implementado na localização. Suportada apenas para o SKU Premium que está a ser implementado no Rede Virtual.
sku

ApiManagementServiceSkuProperties

Propriedades do SKU do serviço Gestão de API.
virtualNetworkConfiguration

VirtualNetworkConfiguration

Configuração de rede virtual para a localização.
zones

string[]

Uma lista de zonas de disponibilidade que indica de onde o recurso precisa de vir.

ApiManagementServiceBackupRestoreParameters

Parâmetros fornecidos para a Cópia de Segurança/Restauro de uma operação de serviço Gestão de API.

Name Tipo Default value Description
accessKey

string

Chave de acesso da conta de armazenamento. Necessário apenas se accessType estiver definido como AccessKey.
accessType

AccessType

AccessKey

O tipo de acesso a utilizar para a conta de armazenamento.
backupName

string

O nome do ficheiro de cópia de segurança a criar/obter.
clientId

string

O ID de Cliente da identidade gerida atribuída pelo utilizador. Necessário apenas se accessType estiver definido como UserAssignedManagedIdentity.
containerName

string

O nome do contentor de blobs (utilizado para colocar/obter a cópia de segurança).
storageAccount

string

O nome da conta de armazenamento do Azure (utilizada para colocar/obter a cópia de segurança).

ApiManagementServiceIdentity

Propriedades de identidade do recurso do serviço de Gestão de Api.

Name Tipo Description
principalId

string

O ID principal da identidade.
tenantId

string

O ID do inquilino do cliente da identidade.
type

ApimIdentityType

O tipo de identidade utilizado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá quaisquer identidades do serviço.
userAssignedIdentities

<string,  UserIdentityProperties>

A lista de identidades de utilizador associadas ao recurso. As referências da chave do dicionário de identidade do utilizador serão ids de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

ApiManagementServiceResource

Um único recurso de serviço Gestão de API em Listar ou Obter resposta.

Name Tipo Default value Description
etag

string

ETag do recurso.
id

string

ID do Recurso.
identity

ApiManagementServiceIdentity

Identidade de serviço gerida do serviço de Gestão de API.
location

string

Localização do recurso.
name

string

Nome do recurso.
properties.additionalLocations

AdditionalLocation[]

Localizações adicionais do datacenter do serviço Gestão de API.
properties.apiVersionConstraint

ApiVersionConstraint

Restrição da versão das Apis do Plano de Controlo para o serviço de Gestão de API.
properties.certificates

CertificateConfiguration[]

Lista de Certificados que precisam de ser instalados no serviço Gestão de API. O máximo de certificados suportados que podem ser instalados é 10.
properties.createdAtUtc

string

Data UTC de criação do serviço Gestão de API. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601.
properties.customProperties

object

Propriedades personalizadas do serviço Gestão de API.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 irá desativar a cifra TLS_RSA_WITH_3DES_EDE_CBC_SHA para todos os TLS(1.0, 1.1 e 1.2).
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 pode ser utilizada para desativar apenas o TLS 1.1.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 pode ser utilizada para desativar o TLS 1.0 num serviço Gestão de API.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 pode ser utilizada para desativar apenas o TLS 1.1 para comunicações com back-ends.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 pode ser utilizada para desativar o TLS 1.0 para comunicações com back-ends.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 pode ser utilizada para ativar o protocolo HTTP2 num serviço Gestão de API.
Não especificar nenhuma destas propriedades na operação PATCH irá repor os valores das propriedades omitidas para as respetivas predefinições. Para todas as definições exceto Http2, o valor predefinido é True se o serviço foi criado em ou antes de 1 de abril de 2018 e False de outra forma. O valor predefinido da definição http2 é False.

Pode desativar qualquer uma das seguintes cifras com as definições Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Por exemplo, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. O valor predefinido é true para eles.
Nota: as seguintes cifras não podem ser desativadas, uma vez que são necessárias por componentes internos da plataforma: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
properties.developerPortalUrl

string

URL do ponto final do portal do DEveloper do serviço Gestão de API.
properties.disableGateway

boolean

False

Propriedade válida apenas para um serviço de Gestão de API implementado em várias localizações. Isto pode ser utilizado para desativar o gateway na região mestra.
properties.enableClientCertificate

boolean

False

Propriedade destinada apenas a ser utilizada para o Serviço SKU de Consumo. Isto impõe a apresentação de um certificado de cliente em cada pedido ao gateway. Isto também permite a capacidade de autenticar o certificado na política no gateway.
properties.gatewayRegionalUrl

string

URL do gateway do serviço Gestão de API na Região Predefinida.
properties.gatewayUrl

string

URL do gateway do serviço Gestão de API.
properties.hostnameConfigurations

HostnameConfiguration[]

Configuração personalizada do nome do anfitrião do serviço Gestão de API.
properties.managementApiUrl

string

URL do ponto final da API de Gestão do serviço Gestão de API.
properties.notificationSenderEmail

string

Email endereço a partir do qual a notificação será enviada.
properties.platformVersion

PlatformVersion

Versão da Plataforma de Computação a executar o serviço nesta localização.
properties.portalUrl

string

Url do ponto final do portal do Publisher do serviço Gestão de API.
properties.privateEndpointConnections

RemotePrivateEndpointConnectionWrapper[]

Lista de Ligações de Ponto Final Privado deste serviço.
properties.privateIPAddresses

string[]

Endereços IP com Balanceamento de Carga Estática Privada do serviço de Gestão de API na região Primária que é implementado numa Rede Virtual Interna. Disponível apenas para SKU Básico, Standard, Premium e Isolado.
properties.provisioningState

string

O estado de aprovisionamento atual do serviço Gestão de API, que pode ser um dos seguintes: Criado/Ativar/Com Êxito/Atualização/Falhado/Parado/Terminação/Terminação Falhou/Eliminado.
properties.publicIPAddresses

string[]

Endereços IP com Balanceamento de Carga Estático Público do serviço Gestão de API na região Primária. Disponível apenas para SKU Básico, Standard, Premium e Isolado.
properties.publicIpAddressId

string

Endereço IP baseado em IP V4 do SKU Standard Público a associar ao serviço implementado Rede Virtual na região. Suportada apenas para Programadores e SKU Premium que estão a ser implementados no Rede Virtual.
properties.publicNetworkAccess

PublicNetworkAccess

Se o acesso ao ponto final público é ou não permitido para este serviço de Gestão de API. O valor é opcional, mas se for transmitido, tem de ser "Ativado" ou "Desativado". Se "Desativado", os pontos finais privados são o método de acesso exclusivo. O valor predefinido é "Ativado"
properties.publisherEmail

string

E-mail do Publisher.
properties.publisherName

string

Nome do publicador.
properties.restore

boolean

False

Anular a eliminação do Serviço de Gestão de API se tiver sido eliminado de forma recuperável anteriormente. Se este sinalizador for especificado e definido como Verdadeiro, todas as outras propriedades serão ignoradas.
properties.scmUrl

string

URL do ponto final do SCM do serviço Gestão de API.
properties.targetProvisioningState

string

O estado de aprovisionamento do serviço Gestão de API, que é visado pela operação de execução prolongada iniciada no serviço.
properties.virtualNetworkConfiguration

VirtualNetworkConfiguration

Configuração da rede virtual do serviço Gestão de API.
properties.virtualNetworkType

VirtualNetworkType

None

O tipo de VPN no qual Gestão de API serviço tem de ser configurado. Nenhum (Valor Predefinido) significa que o serviço Gestão de API não faz parte de nenhum Rede Virtual, Externo significa que a implementação do Gestão de API está configurada dentro de um Rede Virtual ter um Ponto Final Com Acesso à Internet e Interno significa que Gestão de API implementação está configurada dentro de um Rede Virtual ter apenas um Ponto Final Com Acesso à Intranet.
sku

ApiManagementServiceSkuProperties

Propriedades de SKU do serviço Gestão de API.
systemData

systemData

Metadados relativos à criação e última modificação do recurso.
tags

object

Etiquetas de recursos.
type

string

O tipo de recurso para Gestão de API recurso está definido como Microsoft.ApiManagement.
zones

string[]

Uma lista de zonas de disponibilidade que indica a origem do recurso.

ApiManagementServiceSkuProperties

Gestão de API propriedades do SKU do recurso de serviço.

Name Tipo Description
capacity

integer

Capacidade do SKU (número de unidades implementadas do SKU). Para a capacidade de SKU de Consumo tem de ser especificada como 0.
name

SkuType

Nome do SKU.

ApimIdentityType

O tipo de identidade utilizado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá quaisquer identidades do serviço.

Name Tipo Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

ApiVersionConstraint

Restrição da versão das Apis do Plano de Controlo para o serviço Gestão de API.

Name Tipo Description
minApiVersion

string

Limite as chamadas à API do plano de controlo para Gestão de API serviço com uma versão igual ou mais recente do que este valor.

ArmIdWrapper

Um wrapper para um ID de recurso do ARM

Name Tipo Description
id

string

CertificateConfiguration

Configuração do certificado que consiste em intermediários e certificados de raiz não fidedignos.

Name Tipo Description
certificate

CertificateInformation

Informações do certificado.
certificatePassword

string

Palavra-passe do Certificado.
encodedCertificate

string

Certificado codificado Base64.
storeName enum:
  • CertificateAuthority
  • Root

A localização do arquivo de certificados System.Security.Cryptography.x509certificates.StoreName. Apenas Root e CertificateAuthority são localizações válidas.

CertificateInformation

Informações do certificado SSL.

Name Tipo Description
expiry

string

Data de expiração do certificado. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601.
subject

string

Assunto do certificado.
thumbprint

string

Impressão digital do certificado.

CertificateSource

Origem do Certificado.

Name Tipo Description
BuiltIn

string

Custom

string

KeyVault

string

Managed

string

CertificateStatus

Estado do Certificado.

Name Tipo Description
Completed

string

Failed

string

InProgress

string

createdByType

O tipo de identidade que criou o recurso.

Name Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorFieldContract

Contrato de Campo de Erro.

Name Tipo Description
code

string

Código de erro de nível de 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

ErrorFieldContract[]

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.

HostnameConfiguration

Configuração personalizada do nome do anfitrião.

Name Tipo Default value Description
certificate

CertificateInformation

Informações do certificado.
certificatePassword

string

Palavra-passe do Certificado.
certificateSource

CertificateSource

Origem do Certificado.
certificateStatus

CertificateStatus

Estado do Certificado.
defaultSslBinding

boolean

False

Especifique true para configurar o certificado associado a este Nome de Anfitrião como o Certificado SSL Predefinido. Se um cliente não enviar o cabeçalho SNI, este será o certificado que será contestado. A propriedade é útil se um serviço tiver vários nomes de anfitrião personalizados ativados e precisar de decidir sobre o certificado ssl predefinido. A definição só foi aplicada ao Tipo de Nome de Anfitrião Proxy.
encodedCertificate

string

Certificado codificado base64.
hostName

string

Nome do anfitrião para configurar no serviço de Gestão de API.
identityClientId

string

System or User Assigned Managed identity clientId como gerado pelo Azure AD, que tem acesso GET ao keyVault que contém o certificado SSL.
keyVaultId

string

Url para o Segredo do KeyVault que contém o Certificado SSL. Se for fornecido um URL absoluto que contenha a versão, a atualização automática do certificado ssl não funcionará. Isto requer que o serviço de Gestão de API seja configurado com aka.ms/apimmsi. O segredo deve ser do tipo aplicação/x-pkcs12
negotiateClientCertificate

boolean

False

Especifique true para negociar sempre o certificado de cliente no nome do anfitrião. O Valor Predefinido é falso.
type

HostnameType

Tipo de nome de anfitrião.

HostnameType

Tipo de nome de anfitrião.

Name Tipo Description
DeveloperPortal

string

Management

string

Portal

string

Proxy

string

Scm

string

PlatformVersion

Versão da Plataforma de Computação a executar o serviço.

Name Tipo Description
mtv1

string

Plataforma a executar o serviço na plataforma Multi-Inquilino V1.
stv1

string

Plataforma a executar o serviço na plataforma V1 de Inquilino Único.
stv2

string

Plataforma a executar o serviço na plataforma Inquilino Único V2.
undetermined

string

Não é possível determinar a versão da plataforma, uma vez que a plataforma de computação não está implementada.

PrivateEndpointServiceConnectionStatus

O estado da ligação do ponto final privado.

Name Tipo Description
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Uma coleção de informações sobre o estado da ligação entre o consumidor e o fornecedor do serviço.

Name Tipo Description
actionsRequired

string

Uma mensagem a indicar se as alterações no fornecedor de serviços requerem atualizações no consumidor.
description

string

O motivo da aprovação/rejeição da ligação.
status

PrivateEndpointServiceConnectionStatus

Indica se a ligação foi Aprovada/Rejeitada/Removida pelo proprietário do serviço.

PublicNetworkAccess

Se o acesso ao ponto final público é ou não permitido para este serviço de Gestão de API. O valor é opcional, mas, se for transmitido, tem de ser "Ativado" ou "Desativado". Se "Desativado", os pontos finais privados são o método de acesso exclusivo. O valor predefinido é "Ativado"

Name Tipo Description
Disabled

string

Enabled

string

RemotePrivateEndpointConnectionWrapper

Recurso ligação de ponto final privado remoto.

Name Tipo Description
id

string

ID do recurso de ligação de Ponto Final Privado
name

string

Nome da Ligação do Ponto Final Privado
properties.groupIds

string[]

Todos os IDs do Grupo.
properties.privateEndpoint

ArmIdWrapper

O recurso do ponto final privado.
properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Uma coleção de informações sobre o estado da ligação entre o consumidor e o fornecedor do serviço.
properties.provisioningState

string

O estado de aprovisionamento do recurso de ligação de ponto final privado.
type

string

Tipo de Recurso de Ligação de Ponto Final Privado

SkuType

Nome do SKU.

Name Tipo Description
Basic

string

SKU Básico da Gestão de API.
Consumption

string

SKU de Consumo da Gestão de API.
Developer

string

SKU de Programador da Gestão de API.
Isolated

string

SKU isolado da Gestão de API.
Premium

string

SKU Premium da Gestão de API.
Standard

string

SKU Standard da Gestão de API.

systemData

Metadados relativos à criação e última modificação do recurso.

Name Tipo Description
createdAt

string

O carimbo de data/hora da criação de recursos (UTC).
createdBy

string

A identidade que criou o recurso.
createdByType

createdByType

O tipo de identidade que criou o recurso.
lastModifiedAt

string

O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy

string

A identidade que modificou o recurso pela última vez.
lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.

UserIdentityProperties

Name Tipo Description
clientId

string

O ID de cliente da identidade atribuída pelo utilizador.
principalId

string

O ID principal da identidade atribuída pelo utilizador.

VirtualNetworkConfiguration

Configuração de uma rede virtual na qual o serviço Gestão de API é implementado.

Name Tipo Description
subnetResourceId

string

O ID de recurso completo de uma sub-rede numa rede virtual para implementar o serviço Gestão de API.
subnetname

string

O nome da sub-rede.
vnetid

string

O ID da rede virtual. Normalmente, trata-se de um GUID. Por predefinição, espera-se um GUID nulo.

VirtualNetworkType

O tipo de VPN na qual Gestão de API serviço tem de ser configurado. Nenhum (Valor Predefinido) significa que o serviço Gestão de API não faz parte de nenhuma Rede Virtual, Externo significa que a implementação Gestão de API está configurada num Rede Virtual ter um Ponto Final Com Acesso à Internet e Interno significa que Gestão de API implementação está configurada dentro de um Rede Virtual ter apenas um Ponto Final Com Acesso à Intranet.

Name Tipo Description
External

string

O serviço faz parte do Rede Virtual e está acessível a partir da Internet.
Internal

string

O serviço faz parte do Rede Virtual e só está acessível a partir da rede virtual.
None

string

O serviço não faz parte de nenhuma Rede Virtual.