ApiSchema interface
Interfaz que representa una ApiSchema.
Métodos
| begin |
Crea o actualiza la configuración de esquemas de la API. |
| begin |
Crea o actualiza la configuración de esquemas de la API. |
| delete(string, string, string, string, string, Api |
Elimina la configuración de esquemas en la API. |
| get(string, string, string, string, Api |
Obtiene la configuración de esquemas en el nivel de API |
| get |
Obtiene la versión del estado de entidad (Etag) del esquema especificado por su identificador. |
| list |
Obtiene la configuración de esquemas en el nivel de API |
Detalles del método
beginCreateOrUpdate(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)
Crea o actualiza la configuración de esquemas de la API.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- apiId
-
string
Identificador de revisión de API. Debe ser único en la instancia de servicio API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.
- schemaId
-
string
Identificador de identificador de esquema. Debe ser único en la instancia de servicio API Management actual.
- parameters
- SchemaContract
Contenido del esquema que se va a aplicar.
Parámetros de opciones.
Devoluciones
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)
Crea o actualiza la configuración de esquemas de la API.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<ApiSchemaCreateOrUpdateResponse>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- apiId
-
string
Identificador de revisión de API. Debe ser único en la instancia de servicio API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.
- schemaId
-
string
Identificador de identificador de esquema. Debe ser único en la instancia de servicio API Management actual.
- parameters
- SchemaContract
Contenido del esquema que se va a aplicar.
Parámetros de opciones.
Devoluciones
Promise<ApiSchemaCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiSchemaDeleteOptionalParams)
Elimina la configuración de esquemas en la API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, ifMatch: string, options?: ApiSchemaDeleteOptionalParams): Promise<void>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- apiId
-
string
Identificador de revisión de API. Debe ser único en la instancia de servicio API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.
- schemaId
-
string
Identificador de identificador de esquema. Debe ser único en la instancia de servicio API Management actual.
- ifMatch
-
string
ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta del encabezado de la solicitud GET o debe ser * para la actualización incondicional.
- options
- ApiSchemaDeleteOptionalParams
Parámetros de opciones.
Devoluciones
Promise<void>
get(string, string, string, string, ApiSchemaGetOptionalParams)
Obtiene la configuración de esquemas en el nivel de API
function get(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetOptionalParams): Promise<ApiSchemaGetResponse>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- apiId
-
string
Identificador de revisión de API. Debe ser único en la instancia de servicio API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.
- schemaId
-
string
Identificador de identificador de esquema. Debe ser único en la instancia de servicio API Management actual.
- options
- ApiSchemaGetOptionalParams
Parámetros de opciones.
Devoluciones
Promise<ApiSchemaGetResponse>
getEntityTag(string, string, string, string, ApiSchemaGetEntityTagOptionalParams)
Obtiene la versión del estado de entidad (Etag) del esquema especificado por su identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetEntityTagOptionalParams): Promise<ApiSchemaGetEntityTagHeaders>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- apiId
-
string
Identificador de revisión de API. Debe ser único en la instancia de servicio API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.
- schemaId
-
string
Identificador de identificador de esquema. Debe ser único en la instancia de servicio API Management actual.
Parámetros de opciones.
Devoluciones
Promise<ApiSchemaGetEntityTagHeaders>
listByApi(string, string, string, ApiSchemaListByApiOptionalParams)
Obtiene la configuración de esquemas en el nivel de API
function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiSchemaListByApiOptionalParams): PagedAsyncIterableIterator<SchemaContract, SchemaContract[], PageSettings>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- apiId
-
string
Identificador de revisión de API. Debe ser único en la instancia de servicio API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.
- options
- ApiSchemaListByApiOptionalParams
Parámetros de opciones.