ApiSchema interface
Interface représentant une ApiSchema.
Méthodes
| begin |
Crée ou met à jour la configuration du schéma pour l’API. |
| begin |
Crée ou met à jour la configuration du schéma pour l’API. |
| delete(string, string, string, string, string, Api |
Supprime la configuration du schéma sur l’API. |
| get(string, string, string, string, Api |
Obtenez la configuration du schéma au niveau de l’API. |
| get |
Obtient la version d’état d’entité (Etag) du schéma spécifié par son identificateur. |
| list |
Obtenez la configuration du schéma au niveau de l’API. |
Détails de la méthode
beginCreateOrUpdate(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)
Crée ou met à jour la configuration du schéma pour l’API.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.
- schemaId
-
string
Identificateur d’ID de schéma. Doit être unique dans l’instance actuelle du service Gestion des API.
- parameters
- SchemaContract
Contenu du schéma à appliquer.
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)
Crée ou met à jour la configuration du schéma pour l’API.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<ApiSchemaCreateOrUpdateResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.
- schemaId
-
string
Identificateur d’ID de schéma. Doit être unique dans l’instance actuelle du service Gestion des API.
- parameters
- SchemaContract
Contenu du schéma à appliquer.
Paramètres d’options.
Retours
Promise<ApiSchemaCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiSchemaDeleteOptionalParams)
Supprime la configuration du schéma sur l’API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, ifMatch: string, options?: ApiSchemaDeleteOptionalParams): Promise<void>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.
- schemaId
-
string
Identificateur d’ID de schéma. Doit être unique dans l’instance actuelle du service Gestion des API.
- ifMatch
-
string
ETag de l’entité. ETag doit correspondre à l’état actuel de l’entité à partir de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.
- options
- ApiSchemaDeleteOptionalParams
Paramètres d’options.
Retours
Promise<void>
get(string, string, string, string, ApiSchemaGetOptionalParams)
Obtenez la configuration du schéma au niveau de l’API.
function get(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetOptionalParams): Promise<ApiSchemaGetResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.
- schemaId
-
string
Identificateur d’ID de schéma. Doit être unique dans l’instance actuelle du service Gestion des API.
- options
- ApiSchemaGetOptionalParams
Paramètres d’options.
Retours
Promise<ApiSchemaGetResponse>
getEntityTag(string, string, string, string, ApiSchemaGetEntityTagOptionalParams)
Obtient la version d’état d’entité (Etag) du schéma spécifié par son identificateur.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetEntityTagOptionalParams): Promise<ApiSchemaGetEntityTagHeaders>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.
- schemaId
-
string
Identificateur d’ID de schéma. Doit être unique dans l’instance actuelle du service Gestion des API.
Paramètres d’options.
Retours
Promise<ApiSchemaGetEntityTagHeaders>
listByApi(string, string, string, ApiSchemaListByApiOptionalParams)
Obtenez la configuration du schéma au niveau de l’API.
function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiSchemaListByApiOptionalParams): PagedAsyncIterableIterator<SchemaContract, SchemaContract[], PageSettings>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.
- options
- ApiSchemaListByApiOptionalParams
Paramètres d’options.