Service/apis Microsoft.ApiManagement 2021-01-01-preview
Le type de ressource service/apis peut être déployé avec des opérations qui ciblent :
- groupes de ressources - Consultez commandes de déploiement de groupes de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Pour créer une ressource Microsoft.ApiManagement/service/apis, ajoutez le bicep suivant à votre modèle.
resource symbolicname 'Microsoft.ApiManagement/service/apis@2021-01-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
apiRevision: 'string'
apiRevisionDescription: 'string'
apiType: 'string'
apiVersion: 'string'
apiVersionDescription: 'string'
apiVersionSet: {
description: 'string'
id: 'string'
name: 'string'
versionHeaderName: 'string'
versioningScheme: 'string'
versionQueryName: 'string'
}
apiVersionSetId: 'string'
authenticationSettings: {
oAuth2: {
authorizationServerId: 'string'
scope: 'string'
}
openid: {
bearerTokenSendingMethods: [
'string'
]
openidProviderId: 'string'
}
}
contact: {
email: 'string'
name: 'string'
url: 'string'
}
description: 'string'
displayName: 'string'
format: 'string'
isCurrent: bool
license: {
name: 'string'
url: 'string'
}
path: 'string'
protocols: [
'string'
]
serviceUrl: 'string'
sourceApiId: 'string'
subscriptionKeyParameterNames: {
header: 'string'
query: 'string'
}
subscriptionRequired: bool
termsOfServiceUrl: 'string'
type: 'string'
value: 'string'
wsdlSelector: {
wsdlEndpointName: 'string'
wsdlServiceName: 'string'
}
}
}
Nom | Description | Valeur |
---|---|---|
Messagerie électronique | Adresse e-mail de la personne/de l’organisation de contact. DOIT être au format d’une adresse e-mail | corde |
nom | Nom d’identification de la personne/de l’organisation de contact | corde |
URL | URL pointant vers les informations de contact. DOIT être au format d’une URL | corde |
Nom | Description | Valeur |
---|---|---|
apiRevision | Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision 1 par défaut est créée | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 |
apiRevisionDescription | Description de la révision de l’API. | corde Contraintes: Longueur maximale = |
apiType | Type d’API à créer. * http crée une API REST * soap crée une API directe SOAP * websocket crée l’API websocket. |
'http' 'soap' 'websocket' |
apiVersion | Indique l’identificateur de version de l’API si l’API est versionnée | corde Contraintes: Longueur maximale = |
apiVersionDescription | Description de la version de l’API. | corde Contraintes: Longueur maximale = |
apiVersionSet | Détails du jeu de versions | ApiVersionSetContractDetails |
apiVersionSetId | Identificateur de ressource pour l’ApiVersionSet associé. | corde |
authenticationSettings | Collection de paramètres d’authentification inclus dans cette API. | AuthenticationSettingsContract |
contact | Informations de contact pour l’API. | ApiContactInformation |
description | Description de l’API. Peut inclure des balises de mise en forme HTML. | corde |
displayName | Nom de l’API. Doit être de 1 à 300 caractères. | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 |
format | Format du contenu dans lequel l’API est importée. | 'openapi' 'openapi+json' 'openapi+json-link' 'openapi-link' 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link' |
isCurrent | Indique si la révision de l’API est la révision actuelle de l’API. | Bool |
licence | Informations de licence pour l’API. | ApiLicenseInformation |
chemin | URL relative identifiant de manière unique cette API et tous ses chemins de ressources dans l’instance du service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée pendant la création de l’instance de service pour former une URL publique pour cette API. | corde Contraintes: Longueur maximale = (obligatoire) |
protocole | Décrit les protocoles sur lesquels les opérations de cette API peuvent être appelées. | Tableau de chaînes contenant l’un des éléments suivants : 'http' 'https' 'ws' 'wss' |
serviceUrl | URL absolue du service principal implémentant cette API. Ne peut pas comporter plus de 2 000 caractères. | corde Contraintes: Longueur maximale = |
sourceApiId | Identificateur d’API de l’API source. | corde |
subscriptionKeyParameterNames | Protocoles sur lesquels l’API est rendue disponible. | SubscriptionKeyParameterNamesContract |
subscriptionRequired | Spécifie si un abonnement API ou Produit est requis pour accéder à l’API. | Bool |
termsOfServiceUrl | URL vers les conditions d’utilisation de l’API. DOIT être au format d’une URL. | corde |
type | Type d’API. | 'http' 'soap' 'websocket' |
valeur | Valeur de contenu lors de l’importation d’une API. | corde |
wsdlSelector | Critères pour limiter l’importation de WSDL à un sous-ensemble du document. | ApiCreateOrUpdatePropertiesWsdlSelector |
Nom | Description | Valeur |
---|---|---|
wsdlEndpointName | Nom du point de terminaison(port) à importer à partir de WSDL | corde |
wsdlServiceName | Nom du service à importer à partir de WSDL | corde |
Nom | Description | Valeur |
---|---|---|
nom | Nom de licence utilisé pour l’API | corde |
URL | URL de la licence utilisée pour l’API. DOIT être au format d’une URL | corde |
Nom | Description | Valeur |
---|---|---|
description | Description du jeu de versions d’API. | corde |
id | Identificateur de l’ensemble de versions d’API existant. Omettez cette valeur pour créer un jeu de versions. | corde |
nom | Nom complet du jeu de versions de l’API. | corde |
versionHeaderName | Nom du paramètre d’en-tête HTTP qui indique la version de l’API si versioningScheme est défini sur header . |
corde |
versioningScheme | Valeur qui détermine l’emplacement de l’identificateur de version de l’API dans une requête HTTP. | 'Header' 'Query' 'Segment' |
versionQueryName | Nom du paramètre de requête qui indique la version de l’API si versioningScheme a la valeur query . |
corde |
Nom | Description | Valeur |
---|---|---|
oAuth2 | Paramètres d’authentification OAuth2 | OAuth2AuthenticationSettingsContract |
openid | Paramètres d’authentification OpenID Connect | OpenIdAuthenticationSettingsContract |
Nom | Description | Valeur |
---|---|---|
nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 Modèle = ^[^*#&+:<>?]+$ (obligatoire) |
parent | Dans Bicep, vous pouvez spécifier la ressource parente d’une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente. Pour plus d’informations, consultez ressource enfant en dehors de la ressource parente. |
Nom symbolique de la ressource de type : service |
Propriétés | L’entité API crée des propriétés de mise à jour. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
Nom | Description | Valeur |
---|---|---|
authorizationServerId | Identificateur du serveur d’autorisation OAuth. | corde |
portée | étendue des opérations. | corde |
Nom | Description | Valeur |
---|---|---|
bearerTokenSendingMethods | Comment envoyer un jeton au serveur. | Tableau de chaînes contenant l’un des éléments suivants : 'authorizationHeader' 'query' |
openidProviderId | Identificateur du serveur d’autorisation OAuth. | corde |
Nom | Description | Valeur |
---|---|---|
en-tête | Nom de l’en-tête de clé d’abonnement. | corde |
requête | Nom du paramètre de chaîne de requête de clé d’abonnement. | corde |
Le type de ressource service/apis peut être déployé avec des opérations qui ciblent :
- groupes de ressources - Consultez commandes de déploiement de groupes de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Pour créer une ressource Microsoft.ApiManagement/service/apis, ajoutez le code JSON suivant à votre modèle.
{
"type": "Microsoft.ApiManagement/service/apis",
"apiVersion": "2021-01-01-preview",
"name": "string",
"properties": {
"apiRevision": "string",
"apiRevisionDescription": "string",
"apiType": "string",
"apiVersion": "string",
"apiVersionDescription": "string",
"apiVersionSet": {
"description": "string",
"id": "string",
"name": "string",
"versionHeaderName": "string",
"versioningScheme": "string",
"versionQueryName": "string"
},
"apiVersionSetId": "string",
"authenticationSettings": {
"oAuth2": {
"authorizationServerId": "string",
"scope": "string"
},
"openid": {
"bearerTokenSendingMethods": [ "string" ],
"openidProviderId": "string"
}
},
"contact": {
"email": "string",
"name": "string",
"url": "string"
},
"description": "string",
"displayName": "string",
"format": "string",
"isCurrent": "bool",
"license": {
"name": "string",
"url": "string"
},
"path": "string",
"protocols": [ "string" ],
"serviceUrl": "string",
"sourceApiId": "string",
"subscriptionKeyParameterNames": {
"header": "string",
"query": "string"
},
"subscriptionRequired": "bool",
"termsOfServiceUrl": "string",
"type": "string",
"value": "string",
"wsdlSelector": {
"wsdlEndpointName": "string",
"wsdlServiceName": "string"
}
}
}
Nom | Description | Valeur |
---|---|---|
Messagerie électronique | Adresse e-mail de la personne/de l’organisation de contact. DOIT être au format d’une adresse e-mail | corde |
nom | Nom d’identification de la personne/de l’organisation de contact | corde |
URL | URL pointant vers les informations de contact. DOIT être au format d’une URL | corde |
Nom | Description | Valeur |
---|---|---|
apiRevision | Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision 1 par défaut est créée | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 |
apiRevisionDescription | Description de la révision de l’API. | corde Contraintes: Longueur maximale = |
apiType | Type d’API à créer. * http crée une API REST * soap crée une API directe SOAP * websocket crée l’API websocket. |
'http' 'soap' 'websocket' |
apiVersion | Indique l’identificateur de version de l’API si l’API est versionnée | corde Contraintes: Longueur maximale = |
apiVersionDescription | Description de la version de l’API. | corde Contraintes: Longueur maximale = |
apiVersionSet | Détails du jeu de versions | ApiVersionSetContractDetails |
apiVersionSetId | Identificateur de ressource pour l’ApiVersionSet associé. | corde |
authenticationSettings | Collection de paramètres d’authentification inclus dans cette API. | AuthenticationSettingsContract |
contact | Informations de contact pour l’API. | ApiContactInformation |
description | Description de l’API. Peut inclure des balises de mise en forme HTML. | corde |
displayName | Nom de l’API. Doit être de 1 à 300 caractères. | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 |
format | Format du contenu dans lequel l’API est importée. | 'openapi' 'openapi+json' 'openapi+json-link' 'openapi-link' 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link' |
isCurrent | Indique si la révision de l’API est la révision actuelle de l’API. | Bool |
licence | Informations de licence pour l’API. | ApiLicenseInformation |
chemin | URL relative identifiant de manière unique cette API et tous ses chemins de ressources dans l’instance du service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée pendant la création de l’instance de service pour former une URL publique pour cette API. | corde Contraintes: Longueur maximale = (obligatoire) |
protocole | Décrit les protocoles sur lesquels les opérations de cette API peuvent être appelées. | Tableau de chaînes contenant l’un des éléments suivants : 'http' 'https' 'ws' 'wss' |
serviceUrl | URL absolue du service principal implémentant cette API. Ne peut pas comporter plus de 2 000 caractères. | corde Contraintes: Longueur maximale = |
sourceApiId | Identificateur d’API de l’API source. | corde |
subscriptionKeyParameterNames | Protocoles sur lesquels l’API est rendue disponible. | SubscriptionKeyParameterNamesContract |
subscriptionRequired | Spécifie si un abonnement API ou Produit est requis pour accéder à l’API. | Bool |
termsOfServiceUrl | URL vers les conditions d’utilisation de l’API. DOIT être au format d’une URL. | corde |
type | Type d’API. | 'http' 'soap' 'websocket' |
valeur | Valeur de contenu lors de l’importation d’une API. | corde |
wsdlSelector | Critères pour limiter l’importation de WSDL à un sous-ensemble du document. | ApiCreateOrUpdatePropertiesWsdlSelector |
Nom | Description | Valeur |
---|---|---|
wsdlEndpointName | Nom du point de terminaison(port) à importer à partir de WSDL | corde |
wsdlServiceName | Nom du service à importer à partir de WSDL | corde |
Nom | Description | Valeur |
---|---|---|
nom | Nom de licence utilisé pour l’API | corde |
URL | URL de la licence utilisée pour l’API. DOIT être au format d’une URL | corde |
Nom | Description | Valeur |
---|---|---|
description | Description du jeu de versions d’API. | corde |
id | Identificateur de l’ensemble de versions d’API existant. Omettez cette valeur pour créer un jeu de versions. | corde |
nom | Nom complet du jeu de versions de l’API. | corde |
versionHeaderName | Nom du paramètre d’en-tête HTTP qui indique la version de l’API si versioningScheme est défini sur header . |
corde |
versioningScheme | Valeur qui détermine l’emplacement de l’identificateur de version de l’API dans une requête HTTP. | 'Header' 'Query' 'Segment' |
versionQueryName | Nom du paramètre de requête qui indique la version de l’API si versioningScheme a la valeur query . |
corde |
Nom | Description | Valeur |
---|---|---|
oAuth2 | Paramètres d’authentification OAuth2 | OAuth2AuthenticationSettingsContract |
openid | Paramètres d’authentification OpenID Connect | OpenIdAuthenticationSettingsContract |
Nom | Description | Valeur |
---|---|---|
apiVersion | Version de l’API | '2021-01-01-preview' |
nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 Modèle = ^[^*#&+:<>?]+$ (obligatoire) |
Propriétés | L’entité API crée des propriétés de mise à jour. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
type | Type de ressource | 'Microsoft.ApiManagement/service/apis' |
Nom | Description | Valeur |
---|---|---|
authorizationServerId | Identificateur du serveur d’autorisation OAuth. | corde |
portée | étendue des opérations. | corde |
Nom | Description | Valeur |
---|---|---|
bearerTokenSendingMethods | Comment envoyer un jeton au serveur. | Tableau de chaînes contenant l’un des éléments suivants : 'authorizationHeader' 'query' |
openidProviderId | Identificateur du serveur d’autorisation OAuth. | corde |
Nom | Description | Valeur |
---|---|---|
en-tête | Nom de l’en-tête de clé d’abonnement. | corde |
requête | Nom du paramètre de chaîne de requête de clé d’abonnement. | corde |
Le type de ressource service/apis peut être déployé avec des opérations qui ciblent :
- groupes de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Pour créer une ressource Microsoft.ApiManagement/service/apis, ajoutez le terraform suivant à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis@2021-01-01-preview"
name = "string"
body = jsonencode({
properties = {
apiRevision = "string"
apiRevisionDescription = "string"
apiType = "string"
apiVersion = "string"
apiVersionDescription = "string"
apiVersionSet = {
description = "string"
id = "string"
name = "string"
versionHeaderName = "string"
versioningScheme = "string"
versionQueryName = "string"
}
apiVersionSetId = "string"
authenticationSettings = {
oAuth2 = {
authorizationServerId = "string"
scope = "string"
}
openid = {
bearerTokenSendingMethods = [
"string"
]
openidProviderId = "string"
}
}
contact = {
email = "string"
name = "string"
url = "string"
}
description = "string"
displayName = "string"
format = "string"
isCurrent = bool
license = {
name = "string"
url = "string"
}
path = "string"
protocols = [
"string"
]
serviceUrl = "string"
sourceApiId = "string"
subscriptionKeyParameterNames = {
header = "string"
query = "string"
}
subscriptionRequired = bool
termsOfServiceUrl = "string"
type = "string"
value = "string"
wsdlSelector = {
wsdlEndpointName = "string"
wsdlServiceName = "string"
}
}
})
}
Nom | Description | Valeur |
---|---|---|
Messagerie électronique | Adresse e-mail de la personne/de l’organisation de contact. DOIT être au format d’une adresse e-mail | corde |
nom | Nom d’identification de la personne/de l’organisation de contact | corde |
URL | URL pointant vers les informations de contact. DOIT être au format d’une URL | corde |
Nom | Description | Valeur |
---|---|---|
apiRevision | Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision 1 par défaut est créée | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 |
apiRevisionDescription | Description de la révision de l’API. | corde Contraintes: Longueur maximale = |
apiType | Type d’API à créer. * http crée une API REST * soap crée une API directe SOAP * websocket crée l’API websocket. |
'http' 'soap' 'websocket' |
apiVersion | Indique l’identificateur de version de l’API si l’API est versionnée | corde Contraintes: Longueur maximale = |
apiVersionDescription | Description de la version de l’API. | corde Contraintes: Longueur maximale = |
apiVersionSet | Détails du jeu de versions | ApiVersionSetContractDetails |
apiVersionSetId | Identificateur de ressource pour l’ApiVersionSet associé. | corde |
authenticationSettings | Collection de paramètres d’authentification inclus dans cette API. | AuthenticationSettingsContract |
contact | Informations de contact pour l’API. | ApiContactInformation |
description | Description de l’API. Peut inclure des balises de mise en forme HTML. | corde |
displayName | Nom de l’API. Doit être de 1 à 300 caractères. | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 |
format | Format du contenu dans lequel l’API est importée. | 'openapi' 'openapi+json' 'openapi+json-link' 'openapi-link' 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link' |
isCurrent | Indique si la révision de l’API est la révision actuelle de l’API. | Bool |
licence | Informations de licence pour l’API. | ApiLicenseInformation |
chemin | URL relative identifiant de manière unique cette API et tous ses chemins de ressources dans l’instance du service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée pendant la création de l’instance de service pour former une URL publique pour cette API. | corde Contraintes: Longueur maximale = (obligatoire) |
protocole | Décrit les protocoles sur lesquels les opérations de cette API peuvent être appelées. | Tableau de chaînes contenant l’un des éléments suivants : 'http' 'https' 'ws' 'wss' |
serviceUrl | URL absolue du service principal implémentant cette API. Ne peut pas comporter plus de 2 000 caractères. | corde Contraintes: Longueur maximale = |
sourceApiId | Identificateur d’API de l’API source. | corde |
subscriptionKeyParameterNames | Protocoles sur lesquels l’API est rendue disponible. | SubscriptionKeyParameterNamesContract |
subscriptionRequired | Spécifie si un abonnement API ou Produit est requis pour accéder à l’API. | Bool |
termsOfServiceUrl | URL vers les conditions d’utilisation de l’API. DOIT être au format d’une URL. | corde |
type | Type d’API. | 'http' 'soap' 'websocket' |
valeur | Valeur de contenu lors de l’importation d’une API. | corde |
wsdlSelector | Critères pour limiter l’importation de WSDL à un sous-ensemble du document. | ApiCreateOrUpdatePropertiesWsdlSelector |
Nom | Description | Valeur |
---|---|---|
wsdlEndpointName | Nom du point de terminaison(port) à importer à partir de WSDL | corde |
wsdlServiceName | Nom du service à importer à partir de WSDL | corde |
Nom | Description | Valeur |
---|---|---|
nom | Nom de licence utilisé pour l’API | corde |
URL | URL de la licence utilisée pour l’API. DOIT être au format d’une URL | corde |
Nom | Description | Valeur |
---|---|---|
description | Description du jeu de versions d’API. | corde |
id | Identificateur de l’ensemble de versions d’API existant. Omettez cette valeur pour créer un jeu de versions. | corde |
nom | Nom complet du jeu de versions de l’API. | corde |
versionHeaderName | Nom du paramètre d’en-tête HTTP qui indique la version de l’API si versioningScheme est défini sur header . |
corde |
versioningScheme | Valeur qui détermine l’emplacement de l’identificateur de version de l’API dans une requête HTTP. | 'Header' 'Query' 'Segment' |
versionQueryName | Nom du paramètre de requête qui indique la version de l’API si versioningScheme a la valeur query . |
corde |
Nom | Description | Valeur |
---|---|---|
oAuth2 | Paramètres d’authentification OAuth2 | OAuth2AuthenticationSettingsContract |
openid | Paramètres d’authentification OpenID Connect | OpenIdAuthenticationSettingsContract |
Nom | Description | Valeur |
---|---|---|
nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 Modèle = ^[^*#&+:<>?]+$ (obligatoire) |
parent_id | ID de la ressource qui est le parent de cette ressource. | ID de ressource de type : de service |
Propriétés | L’entité API crée des propriétés de mise à jour. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
type | Type de ressource | « Microsoft.ApiManagement/service/apis@2021-01-01-preview » |
Nom | Description | Valeur |
---|---|---|
authorizationServerId | Identificateur du serveur d’autorisation OAuth. | corde |
portée | étendue des opérations. | corde |
Nom | Description | Valeur |
---|---|---|
bearerTokenSendingMethods | Comment envoyer un jeton au serveur. | Tableau de chaînes contenant l’un des éléments suivants : 'authorizationHeader' 'query' |
openidProviderId | Identificateur du serveur d’autorisation OAuth. | corde |
Nom | Description | Valeur |
---|---|---|
en-tête | Nom de l’en-tête de clé d’abonnement. | corde |
requête | Nom du paramètre de chaîne de requête de clé d’abonnement. | corde |