Partilhar via


ApiContract Classe

Definição

Detalhes da API.

[Microsoft.Rest.Serialization.JsonTransformation]
public class ApiContract : Microsoft.Azure.Management.ApiManagement.Models.Resource
[<Microsoft.Rest.Serialization.JsonTransformation>]
type ApiContract = class
    inherit Resource
Public Class ApiContract
Inherits Resource
Herança
ApiContract
Atributos

Construtores

ApiContract()

Inicializa uma nova instância da classe ApiContract.

ApiContract(String, String, String, String, String, AuthenticationSettingsContract, SubscriptionKeyParameterNamesContract, String, String, String, Nullable<Boolean>, Nullable<Boolean>, String, String, String, Nullable<Boolean>, String, ApiContactInformation, ApiLicenseInformation, String, String, String, IList<String>, ApiVersionSetContractDetails)

Inicializa uma nova instância da classe ApiContract.

Propriedades

ApiRevision

Obtém ou define a revisão da API. Se nenhum valor for fornecido, a revisão padrão 1 será criada

ApiRevisionDescription

Obtém ou define a descrição da Revisão de API.

ApiType

Obtém ou define o tipo de API. Os valores possíveis incluem: 'http', 'soap', 'websocket', 'graphql'

ApiVersion

Obtém ou define indica o identificador de versão da API se a API for versão

ApiVersionDescription

Obtém ou define a descrição da Versão da API.

ApiVersionSet

Obtém ou define detalhes do conjunto de versões

ApiVersionSetId

Obtém ou define um identificador de recurso para o ApiVersionSet relacionado.

AuthenticationSettings

Obtém ou define a coleção de configurações de autenticação incluídas nessa API.

Contact

Obtém ou define informações de contato para a API.

Description

Obtém ou define a descrição da API. Pode incluir marcas de formatação HTML.

DisplayName

Obtém ou define o nome da API. Deve ter de 1 a 300 caracteres.

Id

Obtém a ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

(Herdado de Resource)
IsCurrent

Obtém ou define indica se a revisão de API é a revisão de API atual.

IsOnline

Obtém indica se a revisão da API está acessível por meio do gateway.

License

Obtém ou define informações de licença para a API.

Name

Obtém o nome do recurso

(Herdado de Resource)
Path

Obtém ou define a URL relativa que identifica exclusivamente essa API e todos os seus caminhos de recurso na instância de serviço Gerenciamento de API. Ele é acrescentado à URL base do Ponto de Extremidade de API especificada durante a criação da instância de serviço para formar uma URL pública para essa API.

Protocols

Obtém ou define sobre quais protocolos as operações nesta API podem ser invocadas.

ServiceUrl

Obtém ou define a URL absoluta do serviço de back-end que implementa essa API. Não pode ter mais de 2.000 caracteres.

SourceApiId

Obtém ou define o identificador de API da API de origem.

SubscriptionKeyParameterNames

Obtém ou define protocolos sobre os quais a API é disponibilizada.

SubscriptionRequired

Obtém ou define se uma assinatura de API ou produto é necessária para acessar a API.

TermsOfServiceUrl

Obtém ou define uma URL para os Termos de Serviço da API. DEVE estar no formato de uma URL.

Type

Obtém o tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

(Herdado de Resource)

Métodos

Validate()

Valide o objeto .

Aplica-se a