Api Management Service - Backup
Cria um backup do serviço Gerenciamento de API para a conta de Armazenamento do Azure fornecida. Esta é uma operação de execução prolongada e pode levar vários minutos para ser concluída.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backup?api-version=2022-08-01
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas. |
service
|
path | True |
string |
O nome do serviço Gerenciamento de API. Regex pattern: |
subscription
|
path | True |
string |
A ID da assinatura de destino. |
api-version
|
query | True |
string |
A versão da API a ser usada para esta operação. |
Corpo da solicitação
Nome | Obrigatório | Tipo | Description |
---|---|---|---|
backupName | True |
string |
O nome do arquivo de backup a ser criado/recuperado. |
containerName | True |
string |
O nome do contêiner de blob (usado para colocar/recuperar o backup). |
storageAccount | True |
string |
O nome da conta de armazenamento do Azure (usada para colocar/recuperar o backup). |
accessKey |
string |
Chave de acesso da conta de armazenamento. Obrigatório somente se |
|
accessType |
O tipo de acesso a ser usado para a conta de armazenamento. |
||
clientId |
string |
A ID do cliente da identidade gerenciada atribuída pelo usuário. Obrigatório somente se |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Backup com êxito do serviço de Gerenciamento de API para a conta de armazenamento. |
|
202 Accepted |
Aceito: o cabeçalho de localização contém a URL em que o status da operação de execução longa pode ser verificado. Headers Location: string |
|
Other Status Codes |
Resposta de erro que descreve por que a operação falhou. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Description |
---|---|
user_impersonation | representar sua conta de usuário |
Exemplos
Api |
Api |
Api |
ApiManagementBackupWithAccessKey
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backup?api-version=2022-08-01
{
"storageAccount": "teststorageaccount",
"containerName": "backupContainer",
"backupName": "apimService1backup_2017_03_19",
"accessType": "AccessKey",
"accessKey": "**************************************************"
}
Sample Response
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2022-08-01
{
"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
}
}
ApiManagementBackupWithSystemManagedIdentity
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backup?api-version=2022-08-01
{
"storageAccount": "contosorpstorage",
"containerName": "apim-backups",
"backupName": "backup5",
"accessType": "SystemAssignedManagedIdentity"
}
Sample Response
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2022-08-01
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
"name": "apimService1",
"type": "Microsoft.ApiManagement/service",
"tags": {
"Owner": "apimService1"
},
"location": "Central US EUAP",
"etag": "AAAAAAAQM8o=",
"properties": {
"publisherEmail": "apimService1@corp.microsoft.com",
"publisherName": "MS",
"notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
"provisioningState": "Succeeded",
"targetProvisioningState": "",
"createdAtUtc": "2020-04-23T16:26:47.8637967Z",
"gatewayUrl": "https://apimService1.azure-api.net",
"gatewayRegionalUrl": "https://apimService1-centraluseuap-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": true,
"certificateSource": "BuiltIn"
}
],
"publicIPAddresses": [
"52.XXXX.160.66"
],
"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,
"publicNetworkAccess": "Enabled",
"platformVersion": "stv1"
},
"sku": {
"name": "Premium",
"capacity": 1
},
"identity": {
"type": "SystemAssigned, UserAssigned",
"principalId": "00000000-5fb4-4916-95d4-64b306f9d924",
"tenantId": "00000000-86f1-0000-91ab-2d7cd011db47",
"userAssignedIdentities": {
"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": {
"principalId": "00000000-a100-4478-0000-d65d98118ba0",
"clientId": "00000000-a154-4830-0000-46a12da1a1e2"
},
"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": {
"principalId": "00000000-9208-4128-af2d-a10d2af9b5a3",
"clientId": "00000000-6328-4db2-0000-ab0e3e7806cf"
}
}
},
"systemData": {
"lastModifiedBy": "contoso@microsoft.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-06-30T06:24:57.0008037Z"
}
}
ApiManagementBackupWithUserAssignedManagedIdentity
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backup?api-version=2022-08-01
{
"storageAccount": "contosorpstorage",
"containerName": "apim-backups",
"backupName": "backup5",
"accessType": "UserAssignedManagedIdentity",
"clientId": "XXXXX-a154-4830-XXXX-46a12da1a1e2"
}
Sample Response
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2022-08-01
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
"name": "apimService1",
"type": "Microsoft.ApiManagement/service",
"tags": {
"Owner": "apimService1"
},
"location": "Central US EUAP",
"etag": "AAAAAAAQM8o=",
"properties": {
"publisherEmail": "apimService1@corp.microsoft.com",
"publisherName": "MS",
"notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
"provisioningState": "Succeeded",
"targetProvisioningState": "",
"createdAtUtc": "2020-04-23T16:26:47.8637967Z",
"gatewayUrl": "https://apimService1.azure-api.net",
"gatewayRegionalUrl": "https://apimService1-centraluseuap-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": true,
"certificateSource": "BuiltIn"
}
],
"publicIPAddresses": [
"52.XXXX.160.66"
],
"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,
"publicNetworkAccess": "Enabled",
"platformVersion": "stv1"
},
"sku": {
"name": "Premium",
"capacity": 1
},
"identity": {
"type": "SystemAssigned, UserAssigned",
"principalId": "00000000-5fb4-4916-95d4-64b306f9d924",
"tenantId": "00000000-86f1-0000-91ab-2d7cd011db47",
"userAssignedIdentities": {
"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": {
"principalId": "00000000-a100-4478-0000-d65d98118ba0",
"clientId": "00000000-a154-4830-0000-46a12da1a1e2"
},
"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": {
"principalId": "00000000-9208-4128-af2d-a10d2af9b5a3",
"clientId": "00000000-6328-4db2-0000-ab0e3e7806cf"
}
}
},
"systemData": {
"lastModifiedBy": "contoso@microsoft.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-06-30T06:24:57.0008037Z"
}
}
Definições
Nome | Description |
---|---|
Access |
O tipo de acesso a ser usado para a conta de armazenamento. |
Additional |
Descrição de um local de recurso de Gerenciamento de API adicional. |
Api |
Parâmetros fornecidos para o Backup/Restauração de uma operação de serviço Gerenciamento de API. |
Api |
Propriedades de identidade do recurso de serviço de Gerenciamento de API. |
Api |
Um único recurso de serviço Gerenciamento de API em Listar ou Obter resposta. |
Api |
Gerenciamento de API propriedades de SKU do recurso de serviço. |
Apim |
O tipo de identidade usado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá as identidades do serviço. |
Api |
Restrição de versão do Control Plane Apis para o serviço Gerenciamento de API. |
Arm |
Um wrapper para uma ID de recurso do ARM |
Certificate |
Configuração de certificado que consiste em intermediários não confiáveis e certificados raiz. |
Certificate |
Informações de certificado SSL. |
Certificate |
Origem do certificado. |
Certificate |
Status do certificado. |
created |
O tipo de identidade que criou o recurso. |
Error |
Contrato de campo de erro. |
Error |
Resposta de erro. |
Hostname |
Configuração de nome de host personalizado. |
Hostname |
Tipo de nome do host. |
Nat |
A propriedade pode ser usada para habilitar o Gateway da NAT para esse serviço de Gerenciamento de API. |
Platform |
Versão da Plataforma de Computação executando o serviço. |
Private |
A conexão de ponto de extremidade privado status. |
Private |
Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor. |
Public |
Se o acesso ao ponto de extremidade público é permitido ou não para esse serviço Gerenciamento de API. O valor é opcional, mas, se passado, deve ser "Habilitado" ou "Desabilitado". Se 'Desabilitado', os pontos de extremidade privados serão o método de acesso exclusivo. O valor padrão é 'Enabled' |
Remote |
Recurso de conexão de ponto de extremidade privado remoto. |
Sku |
Nome do Sku. |
system |
Metadados relativos à criação e à última modificação do recurso. |
User |
|
Virtual |
Configuração de uma rede virtual na qual Gerenciamento de API serviço é implantado. |
Virtual |
O tipo de VPN no qual Gerenciamento de API serviço precisa ser configurado. Nenhum (Valor Padrão) significa que o serviço de Gerenciamento de API não faz parte de nenhum Rede Virtual, Externo significa que a implantação do Gerenciamento de API está configurada dentro de um Rede Virtual ter um ponto de extremidade voltado para a Internet e o interno significa que Gerenciamento de API a implantação é configurada dentro de um Rede Virtual ter apenas um ponto de extremidade voltado para intranet. |
AccessType
O tipo de acesso a ser usado para a conta de armazenamento.
Nome | Tipo | Description |
---|---|---|
AccessKey |
string |
Use a chave de acesso. |
SystemAssignedManagedIdentity |
string |
Use a identidade gerenciada atribuída pelo sistema. |
UserAssignedManagedIdentity |
string |
Use a identidade gerenciada atribuída pelo usuário. |
AdditionalLocation
Descrição de um local de recurso de Gerenciamento de API adicional.
Nome | Tipo | Valor padrão | Description |
---|---|---|---|
disableGateway |
boolean |
False |
Propriedade válida somente para um serviço de Gerenciamento de API implantado em vários locais. Isso pode ser usado para desabilitar o gateway neste local adicional. |
gatewayRegionalUrl |
string |
URL do gateway do serviço Gerenciamento de API na Região. |
|
location |
string |
O nome da localização da região adicional entre as regiões do Data center do Azure. |
|
natGatewayState | Disabled |
A propriedade pode ser usada para habilitar o Gateway da NAT para esse serviço de Gerenciamento de API. |
|
outboundPublicIPAddresses |
string[] |
Prefixos de endereço IPV4 públicos de saída associados ao serviço implantado do Gateway da NAT. Disponível apenas para SKU Premium na plataforma stv2. |
|
platformVersion |
Versão da Plataforma de Computação executando o serviço. |
||
privateIPAddresses |
string[] |
Endereços IP com balanceamento de carga estático privado do serviço Gerenciamento de API que é implantado em um Rede Virtual Interno em um local adicional específico. Disponível apenas para SKU Básico, Standard, Premium e Isolado. |
|
publicIPAddresses |
string[] |
Endereços IP de balanceamento de carga estáticos públicos do serviço Gerenciamento de API no local adicional. Disponível apenas para SKU Básico, Standard, Premium e Isolado. |
|
publicIpAddressId |
string |
Endereço IP baseado em IP de SKU padrão público V4 a ser associado a Rede Virtual serviço implantado no local. Compatível apenas com o SKU Premium que está sendo implantado no Rede Virtual. |
|
sku |
Propriedades de SKU do serviço Gerenciamento de API. |
||
virtualNetworkConfiguration |
Configuração de rede virtual para o local. |
||
zones |
string[] |
Uma lista de zonas de disponibilidade que indica de onde o recurso precisa vir. |
ApiManagementServiceBackupRestoreParameters
Parâmetros fornecidos para o Backup/Restauração de uma operação de serviço Gerenciamento de API.
Nome | Tipo | Valor padrão | Description |
---|---|---|---|
accessKey |
string |
Chave de acesso da conta de armazenamento. Obrigatório somente se |
|
accessType | AccessKey |
O tipo de acesso a ser usado para a conta de armazenamento. |
|
backupName |
string |
O nome do arquivo de backup a ser criado/recuperado. |
|
clientId |
string |
A ID do cliente da identidade gerenciada atribuída pelo usuário. Obrigatório somente se |
|
containerName |
string |
O nome do contêiner de blob (usado para colocar/recuperar o backup). |
|
storageAccount |
string |
O nome da conta de armazenamento do Azure (usada para colocar/recuperar o backup). |
ApiManagementServiceIdentity
Propriedades de identidade do recurso de serviço de Gerenciamento de API.
Nome | Tipo | Description |
---|---|---|
principalId |
string |
A ID da entidade de segurança da identidade. |
tenantId |
string |
A ID do locatário do cliente da identidade. |
type |
O tipo de identidade usado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá as identidades do serviço. |
|
userAssignedIdentities |
<string,
User |
A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
ApiManagementServiceResource
Um único recurso de serviço Gerenciamento de API em Listar ou Obter resposta.
Nome | Tipo | Valor padrão | Description |
---|---|---|---|
etag |
string |
ETag do recurso. |
|
id |
string |
ID do recurso. |
|
identity |
Identidade de serviço gerenciada do serviço de Gerenciamento de API. |
||
location |
string |
Local do recurso. |
|
name |
string |
Nome do recurso. |
|
properties.additionalLocations |
Locais de datacenter adicionais do serviço Gerenciamento de API. |
||
properties.apiVersionConstraint |
Restrição de versão do Control Plane Apis para o serviço Gerenciamento de API. |
||
properties.certificates |
Lista de certificados que precisam ser instalados no serviço Gerenciamento de API. O máximo de certificados com suporte que podem ser instalados é 10. |
||
properties.createdAtUtc |
string |
Data utc de criação do serviço Gerenciamento de API. A data está em conformidade com o seguinte formato: |
|
properties.customProperties |
object |
Propriedades personalizadas do serviço Gerenciamento de API. |
|
properties.developerPortalUrl |
string |
URL do ponto de extremidade do Portal do DEveloper do serviço Gerenciamento de API. |
|
properties.disableGateway |
boolean |
False |
Propriedade válida somente para um serviço de Gerenciamento de API implantado em vários locais. Isso pode ser usado para desabilitar o gateway em master região. |
properties.enableClientCertificate |
boolean |
False |
Propriedade destinada apenas a ser usada para o Serviço de SKU de Consumo. Isso impõe que um certificado do cliente seja apresentado em cada solicitação para o gateway. Isso também permite a capacidade de autenticar o certificado na política no gateway. |
properties.gatewayRegionalUrl |
string |
URL do gateway do serviço de Gerenciamento de API na Região Padrão. |
|
properties.gatewayUrl |
string |
URL do gateway do serviço Gerenciamento de API. |
|
properties.hostnameConfigurations |
Configuração de nome de host personalizado do serviço Gerenciamento de API. |
||
properties.managementApiUrl |
string |
URL do ponto de extremidade da API de gerenciamento do serviço Gerenciamento de API. |
|
properties.natGatewayState | Disabled |
A propriedade pode ser usada para habilitar o Gateway da NAT para esse serviço de Gerenciamento de API. |
|
properties.notificationSenderEmail |
string |
Email endereço do qual a notificação será enviada. |
|
properties.outboundPublicIPAddresses |
string[] |
Prefixos de endereço IPV4 públicos de saída associados ao serviço implantado do Gateway da NAT. Disponível apenas para SKU Premium na plataforma stv2. |
|
properties.platformVersion |
Versão da Plataforma de Computação executando o serviço neste local. |
||
properties.portalUrl |
string |
Url do ponto de extremidade do portal do editor do serviço Gerenciamento de API. |
|
properties.privateEndpointConnections |
Lista de conexões de ponto de extremidade privado desse serviço. |
||
properties.privateIPAddresses |
string[] |
Endereços IP com balanceamento de carga estático privado do serviço Gerenciamento de API na região Primária, que é implantado em uma Rede Virtual Interna. Disponível apenas para SKU Básico, Standard, Premium e Isolado. |
|
properties.provisioningState |
string |
O estado de provisionamento atual do serviço de Gerenciamento de API que pode ser um dos seguintes: Criado/Ativando/Bem-sucedido/Atualizando/Com Falha/Parado/Encerrando/Terminando Com Falha/Excluído. |
|
properties.publicIPAddresses |
string[] |
Endereços IP de balanceamento de carga estáticos públicos do serviço Gerenciamento 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 de SKU padrão público V4 a ser associado a Rede Virtual serviço implantado na região. Compatível apenas com o SKU Premium e desenvolvedor que está sendo implantado no Rede Virtual. |
|
properties.publicNetworkAccess |
Se o acesso ao ponto de extremidade público é permitido ou não para esse serviço Gerenciamento de API. O valor é opcional, mas, se passado, deve ser "Habilitado" ou "Desabilitado". Se 'Desabilitado', os pontos de extremidade privados serão o método de acesso exclusivo. O valor padrão é 'Enabled' |
||
properties.publisherEmail |
string |
Email do publicador. |
|
properties.publisherName |
string |
Nome do publicador. |
|
properties.restore |
boolean |
False |
Desmarque o Serviço de Gerenciamento de API se ele tiver sido excluído anteriormente. Se esse sinalizador for especificado e definido como True, todas as outras propriedades serão ignoradas. |
properties.scmUrl |
string |
URL do ponto de extremidade SCM do serviço Gerenciamento de API. |
|
properties.targetProvisioningState |
string |
O estado de provisionamento do serviço Gerenciamento de API, que é direcionado pela operação de execução prolongada iniciada no serviço. |
|
properties.virtualNetworkConfiguration |
Configuração de rede virtual do serviço Gerenciamento de API. |
||
properties.virtualNetworkType | None |
O tipo de VPN no qual Gerenciamento de API serviço precisa ser configurado. Nenhum (Valor Padrão) significa que o serviço de Gerenciamento de API não faz parte de nenhum Rede Virtual, Externo significa que a implantação do Gerenciamento de API está configurada dentro de um Rede Virtual ter um ponto de extremidade voltado para a Internet e o interno significa que Gerenciamento de API a implantação é configurada dentro de um Rede Virtual ter apenas um ponto de extremidade voltado para intranet. |
|
sku |
Propriedades de SKU do serviço Gerenciamento de API. |
||
systemData |
Metadados relativos à criação e à última modificação do recurso. |
||
tags |
object |
Marcas de recurso. |
|
type |
string |
O tipo de recurso para Gerenciamento de API recurso é definido como Microsoft.ApiManagement. |
|
zones |
string[] |
Uma lista de zonas de disponibilidade que indica de onde o recurso precisa vir. |
ApiManagementServiceSkuProperties
Gerenciamento de API propriedades de SKU do recurso de serviço.
Nome | Tipo | Description |
---|---|---|
capacity |
integer |
Capacidade do SKU (número de unidades implantadas do SKU). Para a capacidade de SKU de Consumo, deve ser especificado como 0. |
name |
Nome do Sku. |
ApimIdentityType
O tipo de identidade usado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá as identidades do serviço.
Nome | Tipo | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
ApiVersionConstraint
Restrição de versão do Control Plane Apis para o serviço Gerenciamento de API.
Nome | Tipo | Description |
---|---|---|
minApiVersion |
string |
Limite as chamadas à API do painel de controle para Gerenciamento de API serviço com versão igual ou mais recente que esse valor. |
ArmIdWrapper
Um wrapper para uma ID de recurso do ARM
Nome | Tipo | Description |
---|---|---|
id |
string |
CertificateConfiguration
Configuração de certificado que consiste em intermediários não confiáveis e certificados raiz.
Nome | Tipo | Description |
---|---|---|
certificate |
Informações de certificado. |
|
certificatePassword |
string |
Senha do certificado. |
encodedCertificate |
string |
Certificado codificado em Base64. |
storeName |
enum:
|
O local do repositório de certificados System.Security.Cryptography.x509certificates.StoreName. Somente Root e CertificateAuthority são locais válidos. |
CertificateInformation
Informações de certificado SSL.
Nome | Tipo | Description |
---|---|---|
expiry |
string |
Data de validade do certificado. A data está em conformidade com o seguinte formato: |
subject |
string |
Assunto do certificado. |
thumbprint |
string |
Impressão digital do certificado. |
CertificateSource
Origem do certificado.
Nome | Tipo | Description |
---|---|---|
BuiltIn |
string |
|
Custom |
string |
|
KeyVault |
string |
|
Managed |
string |
CertificateStatus
Status do certificado.
Nome | Tipo | Description |
---|---|---|
Completed |
string |
|
Failed |
string |
|
InProgress |
string |
createdByType
O tipo de identidade que criou o recurso.
Nome | Tipo | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorFieldContract
Contrato de campo de erro.
Nome | Tipo | Description |
---|---|---|
code |
string |
Código de erro no nível da propriedade. |
message |
string |
Representação legível por humanos do erro no nível da propriedade. |
target |
string |
Nome da propriedade. |
ErrorResponse
Resposta de erro.
Nome | Tipo | Description |
---|---|---|
error.code |
string |
Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta. |
error.details |
A lista de campos inválidos enviados na solicitação, em caso de erro de validação. |
|
error.message |
string |
Representação legível ao olho humano do erro. |
HostnameConfiguration
Configuração de nome de host personalizado.
Nome | Tipo | Valor padrão | Description |
---|---|---|---|
certificate |
Informações de certificado. |
||
certificatePassword |
string |
Senha do certificado. |
|
certificateSource |
Origem do certificado. |
||
certificateStatus |
Status do certificado. |
||
defaultSslBinding |
boolean |
False |
Especifique true para configurar o certificado associado a esse Nome de Host como o Certificado SSL Padrão. Se um cliente não enviar o cabeçalho SNI, esse será o certificado que será desafiado. A propriedade será útil se um serviço tiver vários nomes de host personalizados habilitados e precisar decidir sobre o certificado ssl padrão. A configuração aplicada somente ao Tipo de Nome do Host do gateway. |
encodedCertificate |
string |
Certificado codificado em Base64. |
|
hostName |
string |
Nome do host a ser configurado no serviço de Gerenciamento de API. |
|
identityClientId |
string |
System ou User Assigned Managed identity clientId, conforme gerado por Azure AD, que tem acesso GET ao keyVault que contém o certificado SSL. |
|
keyVaultId |
string |
Url para o Segredo KeyVault que contém o Certificado SsL. Se a URL absoluta que contém a versão for fornecida, a atualização automática do certificado SSL não funcionará. Isso exige que o serviço de Gerenciamento de API seja configurado com aka.ms/apimmsi. O segredo deve ser do tipo application/x-pkcs12 |
|
negotiateClientCertificate |
boolean |
False |
Especifique true para sempre negociar o certificado do cliente no nome do host. O valor padrão é false. |
type |
Tipo de nome do host. |
HostnameType
Tipo de nome do host.
Nome | Tipo | Description |
---|---|---|
DeveloperPortal |
string |
|
Management |
string |
|
Portal |
string |
|
Proxy |
string |
|
Scm |
string |
NatGatewayState
A propriedade pode ser usada para habilitar o Gateway da NAT para esse serviço de Gerenciamento de API.
Nome | Tipo | Description |
---|---|---|
Disabled |
string |
O Gateway nat está desabilitado para o serviço. |
Enabled |
string |
O Gateway nat está habilitado para o serviço. |
PlatformVersion
Versão da Plataforma de Computação executando o serviço.
Nome | Tipo | Description |
---|---|---|
mtv1 |
string |
Plataforma executando o serviço na plataforma V1 multilocatário. |
stv1 |
string |
Plataforma executando o serviço na plataforma de Locatário Único V1. |
stv2 |
string |
Plataforma que executa o serviço na plataforma de Locatário Único V2. |
undetermined |
string |
A versão da plataforma não pode ser determinada, pois a plataforma de computação não é implantada. |
PrivateEndpointServiceConnectionStatus
A conexão de ponto de extremidade privado status.
Nome | Tipo | Description |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.
Nome | Tipo | Description |
---|---|---|
actionsRequired |
string |
Uma mensagem indicando se as alterações no provedor de serviços exigem atualizações no consumidor. |
description |
string |
O motivo da aprovação/rejeição da conexão. |
status |
Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço. |
PublicNetworkAccess
Se o acesso ao ponto de extremidade público é permitido ou não para esse serviço Gerenciamento de API. O valor é opcional, mas, se passado, deve ser "Habilitado" ou "Desabilitado". Se 'Desabilitado', os pontos de extremidade privados serão o método de acesso exclusivo. O valor padrão é 'Enabled'
Nome | Tipo | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
RemotePrivateEndpointConnectionWrapper
Recurso de conexão de ponto de extremidade privado remoto.
Nome | Tipo | Description |
---|---|---|
id |
string |
ID do recurso de conexão do ponto de extremidade privado |
name |
string |
Nome da conexão do ponto de extremidade privado |
properties.groupIds |
string[] |
Todas as IDs de grupo. |
properties.privateEndpoint |
O recurso do ponto de extremidade privado. |
|
properties.privateLinkServiceConnectionState |
Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor. |
|
properties.provisioningState |
string |
O estado de provisionamento do recurso de conexão de ponto de extremidade privado. |
type |
string |
Tipo de recurso de conexão de ponto de extremidade privado |
SkuType
Nome do Sku.
Nome | Tipo | Description |
---|---|---|
Basic |
string |
SKU básica do Gerenciamento de API. |
Consumption |
string |
SKU de consumo do Gerenciamento de API. |
Developer |
string |
SKU do desenvolvedor do Gerenciamento de API. |
Isolated |
string |
SKU isolado do Gerenciamento de API. |
Premium |
string |
SKU Premium do Gerenciamento de API. |
Standard |
string |
SKU padrão do Gerenciamento de API. |
systemData
Metadados relativos à criação e à última modificação do recurso.
Nome | Tipo | Description |
---|---|---|
createdAt |
string |
O carimbo de data/hora da criação de recursos (UTC). |
createdBy |
string |
A identidade que criou o recurso. |
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 |
O tipo de identidade que modificou o recurso pela última vez. |
UserIdentityProperties
Nome | Tipo | Description |
---|---|---|
clientId |
string |
A ID do cliente da identidade atribuída pelo usuário. |
principalId |
string |
A ID principal da identidade atribuída pelo usuário. |
VirtualNetworkConfiguration
Configuração de uma rede virtual na qual Gerenciamento de API serviço é implantado.
Nome | Tipo | Description |
---|---|---|
subnetResourceId |
string |
A ID de recurso completa de uma sub-rede em uma rede virtual para implantar o serviço Gerenciamento de API. |
subnetname |
string |
O nome da sub-rede. |
vnetid |
string |
A ID da rede virtual. Normalmente, esse é um GUID. Espere um GUID nulo por padrão. |
VirtualNetworkType
O tipo de VPN no qual Gerenciamento de API serviço precisa ser configurado. Nenhum (Valor Padrão) significa que o serviço de Gerenciamento de API não faz parte de nenhum Rede Virtual, Externo significa que a implantação do Gerenciamento de API está configurada dentro de um Rede Virtual ter um ponto de extremidade voltado para a Internet e o interno significa que Gerenciamento de API a implantação é configurada dentro de um Rede Virtual ter apenas um ponto de extremidade voltado para intranet.
Nome | Tipo | Description |
---|---|---|
External |
string |
O serviço faz parte do Rede Virtual e pode ser acessado pela Internet. |
Internal |
string |
O serviço faz parte do Rede Virtual e só pode ser acessado de dentro da rede virtual. |
None |
string |
O serviço não faz parte de nenhuma Rede Virtual. |