ApiSchema interface
Интерфейс, представляющий ApiSchema.
Методы
| begin |
Создает или обновляет конфигурацию схемы для API. |
| begin |
Создает или обновляет конфигурацию схемы для API. |
| delete(string, string, string, string, string, Api |
Удаляет конфигурацию схемы в API. |
| get(string, string, string, string, Api |
Получает конфигурацию схемы на уровне API. |
| get |
Возвращает версию состояния сущности (Etag) схемы, заданной ее идентификатором. |
| list |
Получает конфигурацию схемы на уровне API. |
Сведения о методе
beginCreateOrUpdate(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)
Создает или обновляет конфигурацию схемы для API.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- apiId
-
string
Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. В качестве суффикса текущей редакции имеется ;rev=n, где n — номер редакции.
- schemaId
-
string
Идентификатор идентификатора схемы. Должен быть уникальным в текущем экземпляре службы Управление API.
- parameters
- SchemaContract
Применяемая схема содержимого.
Параметры параметров.
Возвращаемое значение
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)
Создает или обновляет конфигурацию схемы для API.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<ApiSchemaCreateOrUpdateResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- apiId
-
string
Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. В качестве суффикса текущей редакции имеется ;rev=n, где n — номер редакции.
- schemaId
-
string
Идентификатор идентификатора схемы. Должен быть уникальным в текущем экземпляре службы Управление API.
- parameters
- SchemaContract
Применяемая схема содержимого.
Параметры параметров.
Возвращаемое значение
Promise<ApiSchemaCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiSchemaDeleteOptionalParams)
Удаляет конфигурацию схемы в API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, ifMatch: string, options?: ApiSchemaDeleteOptionalParams): Promise<void>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- apiId
-
string
Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. В качестве суффикса текущей редакции имеется ;rev=n, где n — номер редакции.
- schemaId
-
string
Идентификатор идентификатора схемы. Должен быть уникальным в текущем экземпляре службы Управление API.
- ifMatch
-
string
ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.
- options
- ApiSchemaDeleteOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<void>
get(string, string, string, string, ApiSchemaGetOptionalParams)
Получает конфигурацию схемы на уровне API.
function get(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetOptionalParams): Promise<ApiSchemaGetResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- apiId
-
string
Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. В качестве суффикса текущей редакции имеется ;rev=n, где n — номер редакции.
- schemaId
-
string
Идентификатор идентификатора схемы. Должен быть уникальным в текущем экземпляре службы Управление API.
- options
- ApiSchemaGetOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<ApiSchemaGetResponse>
getEntityTag(string, string, string, string, ApiSchemaGetEntityTagOptionalParams)
Возвращает версию состояния сущности (Etag) схемы, заданной ее идентификатором.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetEntityTagOptionalParams): Promise<ApiSchemaGetEntityTagHeaders>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- apiId
-
string
Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. В качестве суффикса текущей редакции имеется ;rev=n, где n — номер редакции.
- schemaId
-
string
Идентификатор идентификатора схемы. Должен быть уникальным в текущем экземпляре службы Управление API.
Параметры параметров.
Возвращаемое значение
Promise<ApiSchemaGetEntityTagHeaders>
listByApi(string, string, string, ApiSchemaListByApiOptionalParams)
Получает конфигурацию схемы на уровне API.
function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiSchemaListByApiOptionalParams): PagedAsyncIterableIterator<SchemaContract, SchemaContract[], PageSettings>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- apiId
-
string
Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. В качестве суффикса текущей редакции имеется ;rev=n, где n — номер редакции.
- options
- ApiSchemaListByApiOptionalParams
Параметры параметров.