ApiVersionSet interface
Interface que representa um ApiVersionSet.
Métodos
create |
Cria ou atualiza um conjunto de versões de API. |
delete(string, string, string, string, Api |
Exclui o conjunto de versões de API específico. |
get(string, string, string, Api |
Obtém os detalhes do Conjunto de Versões da API especificado por seu identificador. |
get |
Obtém a versão do estado da entidade (Etag) do Conjunto de Versões da API especificado por seu identificador. |
list |
Lista uma coleção de conjuntos de versão de API na instância de serviço especificada. |
update(string, string, string, string, Api |
Atualizações os detalhes do VersionSet da API especificado por seu identificador. |
Detalhes do método
createOrUpdate(string, string, string, ApiVersionSetContract, ApiVersionSetCreateOrUpdateOptionalParams)
Cria ou atualiza um conjunto de versões de API.
function createOrUpdate(resourceGroupName: string, serviceName: string, versionSetId: string, parameters: ApiVersionSetContract, options?: ApiVersionSetCreateOrUpdateOptionalParams): Promise<ApiVersionSetCreateOrUpdateResponse>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- versionSetId
-
string
Identificador do Conjunto de Versão da API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- parameters
- ApiVersionSetContract
Criar ou atualizar parâmetros.
Os parâmetros de opções.
Retornos
Promise<ApiVersionSetCreateOrUpdateResponse>
delete(string, string, string, string, ApiVersionSetDeleteOptionalParams)
Exclui o conjunto de versões de API específico.
function delete(resourceGroupName: string, serviceName: string, versionSetId: string, ifMatch: string, options?: ApiVersionSetDeleteOptionalParams): Promise<void>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- versionSetId
-
string
Identificador do Conjunto de Versão da API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- ifMatch
-
string
ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.
Os parâmetros de opções.
Retornos
Promise<void>
get(string, string, string, ApiVersionSetGetOptionalParams)
Obtém os detalhes do Conjunto de Versões da API especificado por seu identificador.
function get(resourceGroupName: string, serviceName: string, versionSetId: string, options?: ApiVersionSetGetOptionalParams): Promise<ApiVersionSetGetResponse>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- versionSetId
-
string
Identificador do Conjunto de Versão da API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- options
- ApiVersionSetGetOptionalParams
Os parâmetros de opções.
Retornos
Promise<ApiVersionSetGetResponse>
getEntityTag(string, string, string, ApiVersionSetGetEntityTagOptionalParams)
Obtém a versão do estado da entidade (Etag) do Conjunto de Versões da API especificado por seu identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, versionSetId: string, options?: ApiVersionSetGetEntityTagOptionalParams): Promise<ApiVersionSetGetEntityTagHeaders>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- versionSetId
-
string
Identificador do Conjunto de Versão da API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
Os parâmetros de opções.
Retornos
Promise<ApiVersionSetGetEntityTagHeaders>
listByService(string, string, ApiVersionSetListByServiceOptionalParams)
Lista uma coleção de conjuntos de versão de API na instância de serviço especificada.
function listByService(resourceGroupName: string, serviceName: string, options?: ApiVersionSetListByServiceOptionalParams): PagedAsyncIterableIterator<ApiVersionSetContract, ApiVersionSetContract[], PageSettings>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
Os parâmetros de opções.
Retornos
update(string, string, string, string, ApiVersionSetUpdateParameters, ApiVersionSetUpdateOptionalParams)
Atualizações os detalhes do VersionSet da API especificado por seu identificador.
function update(resourceGroupName: string, serviceName: string, versionSetId: string, ifMatch: string, parameters: ApiVersionSetUpdateParameters, options?: ApiVersionSetUpdateOptionalParams): Promise<ApiVersionSetUpdateResponse>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- versionSetId
-
string
Identificador do Conjunto de Versão da API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- ifMatch
-
string
ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.
- parameters
- ApiVersionSetUpdateParameters
Atualizar parâmetros.
Os parâmetros de opções.
Retornos
Promise<ApiVersionSetUpdateResponse>