ApimanagementFunctions

Functions

Link copied to clipboard
suspend fun getApi(argument: GetApiPlainArgs): GetApiResult

Gets the details of the API specified by its identifier. API Version: 2020-12-01.

suspend fun getApi(argument: suspend GetApiPlainArgsBuilder.() -> Unit): GetApiResult
suspend fun getApi(apiId: String, resourceGroupName: String, serviceName: String): GetApiResult
Link copied to clipboard

Gets the details of the Diagnostic for an API specified by its identifier. API Version: 2020-12-01.

suspend fun getApiDiagnostic(apiId: String, diagnosticId: String, resourceGroupName: String, serviceName: String): GetApiDiagnosticResult
Link copied to clipboard

Gets the details of the Issue for an API specified by its identifier. API Version: 2020-12-01.

suspend fun getApiIssue(argument: suspend GetApiIssuePlainArgsBuilder.() -> Unit): GetApiIssueResult
suspend fun getApiIssue(apiId: String, expandCommentsAttachments: Boolean? = null, issueId: String, resourceGroupName: String, serviceName: String): GetApiIssueResult
Link copied to clipboard

Gets the details of the issue Attachment for an API specified by its identifier. API Version: 2020-12-01.

suspend fun getApiIssueAttachment(apiId: String, attachmentId: String, issueId: String, resourceGroupName: String, serviceName: String): GetApiIssueAttachmentResult
Link copied to clipboard

Gets the details of the issue Comment for an API specified by its identifier. API Version: 2020-12-01.

suspend fun getApiIssueComment(apiId: String, commentId: String, issueId: String, resourceGroupName: String, serviceName: String): GetApiIssueCommentResult
Link copied to clipboard

Gets an API Management service resource description. API Version: 2020-12-01.

suspend fun getApiManagementService(resourceGroupName: String, serviceName: String): GetApiManagementServiceResult

Get the custom domain ownership identifier for an API Management service. API Version: 2020-12-01.

Link copied to clipboard

Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes. API Version: 2020-12-01.

Link copied to clipboard

Gets the details of the API Operation specified by its identifier. API Version: 2020-12-01.

suspend fun getApiOperation(apiId: String, operationId: String, resourceGroupName: String, serviceName: String): GetApiOperationResult
Link copied to clipboard

Get the policy configuration at the API Operation level. API Version: 2020-12-01.

suspend fun getApiOperationPolicy(apiId: String, format: String? = null, operationId: String, policyId: String, resourceGroupName: String, serviceName: String): GetApiOperationPolicyResult
Link copied to clipboard

Get the policy configuration at the API level. API Version: 2020-12-01.

suspend fun getApiPolicy(apiId: String, format: String? = null, policyId: String, resourceGroupName: String, serviceName: String): GetApiPolicyResult
Link copied to clipboard

Returns the details of an API release. API Version: 2020-12-01.

suspend fun getApiRelease(apiId: String, releaseId: String, resourceGroupName: String, serviceName: String): GetApiReleaseResult
Link copied to clipboard

Get the schema configuration at the API level. API Version: 2020-12-01.

suspend fun getApiSchema(apiId: String, resourceGroupName: String, schemaId: String, serviceName: String): GetApiSchemaResult
Link copied to clipboard

Get Tag description in scope of API API Version: 2020-12-01.

suspend fun getApiTagDescription(apiId: String, resourceGroupName: String, serviceName: String, tagDescriptionId: String): GetApiTagDescriptionResult
Link copied to clipboard

Gets the details of the Api Version Set specified by its identifier. API Version: 2020-12-01.

suspend fun getApiVersionSet(resourceGroupName: String, serviceName: String, versionSetId: String): GetApiVersionSetResult
Link copied to clipboard

Gets the details of the authorization server specified by its identifier. API Version: 2020-12-01.

suspend fun getAuthorizationServer(authsid: String, resourceGroupName: String, serviceName: String): GetAuthorizationServerResult
Link copied to clipboard

Gets the details of the backend specified by its identifier. API Version: 2020-12-01.

suspend fun getBackend(argument: suspend GetBackendPlainArgsBuilder.() -> Unit): GetBackendResult
suspend fun getBackend(backendId: String, resourceGroupName: String, serviceName: String): GetBackendResult
Link copied to clipboard
suspend fun getCache(argument: GetCachePlainArgs): GetCacheResult

Gets the details of the Cache specified by its identifier. API Version: 2020-12-01.

suspend fun getCache(argument: suspend GetCachePlainArgsBuilder.() -> Unit): GetCacheResult
suspend fun getCache(cacheId: String, resourceGroupName: String, serviceName: String): GetCacheResult
Link copied to clipboard

Gets the details of the certificate specified by its identifier. API Version: 2020-12-01.

suspend fun getCertificate(certificateId: String, resourceGroupName: String, serviceName: String): GetCertificateResult
Link copied to clipboard

Returns the developer portal's content item specified by its identifier. API Version: 2020-12-01.

suspend fun getContentItem(contentItemId: String, contentTypeId: String, resourceGroupName: String, serviceName: String): GetContentItemResult
Link copied to clipboard

Gets the details of the developer portal's content type. Content types describe content items' properties, validation rules, and constraints. API Version: 2020-12-01.

suspend fun getContentType(contentTypeId: String, resourceGroupName: String, serviceName: String): GetContentTypeResult
Link copied to clipboard

Gets the details of the Diagnostic specified by its identifier. API Version: 2020-12-01.

suspend fun getDiagnostic(diagnosticId: String, resourceGroupName: String, serviceName: String): GetDiagnosticResult
Link copied to clipboard

Gets the details of the email template specified by its identifier. API Version: 2020-12-01.

suspend fun getEmailTemplate(resourceGroupName: String, serviceName: String, templateName: String): GetEmailTemplateResult
Link copied to clipboard

Gets the details of the Gateway specified by its identifier. API Version: 2020-12-01.

suspend fun getGateway(argument: suspend GetGatewayPlainArgsBuilder.() -> Unit): GetGatewayResult
suspend fun getGateway(gatewayId: String, resourceGroupName: String, serviceName: String): GetGatewayResult
Link copied to clipboard

Get assigned Gateway Certificate Authority details. API Version: 2020-12-01.

suspend fun getGatewayCertificateAuthority(certificateId: String, gatewayId: String, resourceGroupName: String, serviceName: String): GetGatewayCertificateAuthorityResult
Link copied to clipboard
suspend fun getGroup(argument: GetGroupPlainArgs): GetGroupResult

Gets the details of the group specified by its identifier. API Version: 2020-12-01.

suspend fun getGroup(argument: suspend GetGroupPlainArgsBuilder.() -> Unit): GetGroupResult
suspend fun getGroup(groupId: String, resourceGroupName: String, serviceName: String): GetGroupResult
Link copied to clipboard

Gets the configuration details of the identity Provider configured in specified service instance. API Version: 2020-12-01.

suspend fun getIdentityProvider(identityProviderName: String, resourceGroupName: String, serviceName: String): GetIdentityProviderResult
Link copied to clipboard

Gets the details of the logger specified by its identifier. API Version: 2020-12-01.

suspend fun getLogger(argument: suspend GetLoggerPlainArgsBuilder.() -> Unit): GetLoggerResult
suspend fun getLogger(loggerId: String, resourceGroupName: String, serviceName: String): GetLoggerResult
Link copied to clipboard

Gets the details of the named value specified by its identifier. API Version: 2020-12-01.

suspend fun getNamedValue(namedValueId: String, resourceGroupName: String, serviceName: String): GetNamedValueResult
Link copied to clipboard

Gets specific OpenID Connect Provider without secrets. API Version: 2020-12-01.

suspend fun getOpenIdConnectProvider(opid: String, resourceGroupName: String, serviceName: String): GetOpenIdConnectProviderResult
Link copied to clipboard

Get the Global policy definition of the Api Management service. API Version: 2020-12-01.

suspend fun getPolicy(argument: suspend GetPolicyPlainArgsBuilder.() -> Unit): GetPolicyResult
suspend fun getPolicy(format: String? = null, policyId: String, resourceGroupName: String, serviceName: String): GetPolicyResult
Link copied to clipboard

Gets a policy fragment. API Version: 2021-12-01-preview.

suspend fun getPolicyFragment(format: String? = null, id: String, resourceGroupName: String, serviceName: String): GetPolicyFragmentResult
Link copied to clipboard

Gets the details of the Private Endpoint Connection specified by its identifier. API Version: 2021-04-01-preview.

suspend fun getPrivateEndpointConnectionByName(privateEndpointConnectionName: String, resourceGroupName: String, serviceName: String): GetPrivateEndpointConnectionByNameResult
Link copied to clipboard

Gets the details of the product specified by its identifier. API Version: 2020-12-01.

suspend fun getProduct(argument: suspend GetProductPlainArgsBuilder.() -> Unit): GetProductResult
suspend fun getProduct(productId: String, resourceGroupName: String, serviceName: String): GetProductResult
Link copied to clipboard

Get the policy configuration at the Product level. API Version: 2020-12-01.

suspend fun getProductPolicy(format: String? = null, policyId: String, productId: String, resourceGroupName: String, serviceName: String): GetProductPolicyResult
Link copied to clipboard

Gets the details of the property specified by its identifier. API Version: 2019-01-01.

suspend fun getProperty(argument: suspend GetPropertyPlainArgsBuilder.() -> Unit): GetPropertyResult
suspend fun getProperty(propId: String, resourceGroupName: String, serviceName: String): GetPropertyResult
Link copied to clipboard

Gets the details of the Schema specified by its identifier. API Version: 2021-04-01-preview.

suspend fun getSchema(argument: suspend GetSchemaPlainArgsBuilder.() -> Unit): GetSchemaResult
suspend fun getSchema(resourceGroupName: String, schemaId: String, serviceName: String): GetSchemaResult
Link copied to clipboard

Gets the specified Subscription entity. API Version: 2020-12-01.

suspend fun getSubscription(resourceGroupName: String, serviceName: String, sid: String): GetSubscriptionResult
Link copied to clipboard
suspend fun getTag(argument: GetTagPlainArgs): GetTagResult

Gets the details of the tag specified by its identifier. API Version: 2020-12-01.

suspend fun getTag(argument: suspend GetTagPlainArgsBuilder.() -> Unit): GetTagResult
suspend fun getTag(resourceGroupName: String, serviceName: String, tagId: String): GetTagResult
Link copied to clipboard

Get tag associated with the API. API Version: 2020-12-01.

suspend fun getTagByApi(argument: suspend GetTagByApiPlainArgsBuilder.() -> Unit): GetTagByApiResult
suspend fun getTagByApi(apiId: String, resourceGroupName: String, serviceName: String, tagId: String): GetTagByApiResult
Link copied to clipboard

Get tag associated with the Operation. API Version: 2020-12-01.

suspend fun getTagByOperation(apiId: String, operationId: String, resourceGroupName: String, serviceName: String, tagId: String): GetTagByOperationResult
Link copied to clipboard

Get tag associated with the Product. API Version: 2020-12-01.

suspend fun getTagByProduct(productId: String, resourceGroupName: String, serviceName: String, tagId: String): GetTagByProductResult
Link copied to clipboard
suspend fun getUser(argument: GetUserPlainArgs): GetUserResult

Gets the details of the user specified by its identifier. API Version: 2020-12-01.

suspend fun getUser(argument: suspend GetUserPlainArgsBuilder.() -> Unit): GetUserResult
suspend fun getUser(resourceGroupName: String, serviceName: String, userId: String): GetUserResult
Link copied to clipboard

Gets the Shared Access Authorization Token for the User. API Version: 2020-12-01.

suspend fun getUserSharedAccessToken(expiry: String, keyType: KeyType, resourceGroupName: String, serviceName: String, userId: String): GetUserSharedAccessTokenResult
Link copied to clipboard

Gets the client secret details of the authorization server. API Version: 2020-12-01.

suspend fun listAuthorizationServerSecrets(authsid: String, resourceGroupName: String, serviceName: String): ListAuthorizationServerSecretsResult
Link copied to clipboard

Gets the secret validation key of the DelegationSettings. API Version: 2020-12-01.

suspend fun listDelegationSettingSecrets(resourceGroupName: String, serviceName: String): ListDelegationSettingSecretsResult
Link copied to clipboard

Retrieves gateway keys. API Version: 2020-12-01.

suspend fun listGatewayKeys(gatewayId: String, resourceGroupName: String, serviceName: String): ListGatewayKeysResult
Link copied to clipboard

Gets the client secret details of the Identity Provider. API Version: 2020-12-01.

suspend fun listIdentityProviderSecrets(identityProviderName: String, resourceGroupName: String, serviceName: String): ListIdentityProviderSecretsResult
Link copied to clipboard

Gets the secret of the named value specified by its identifier. API Version: 2020-12-01.

suspend fun listNamedValue(namedValueId: String, resourceGroupName: String, serviceName: String): ListNamedValueResult
Link copied to clipboard
Link copied to clipboard

Lists policy resources that reference the policy fragment. API Version: 2021-12-01-preview.

suspend fun listPolicyFragmentReferences(id: String, resourceGroupName: String, serviceName: String, skip: Int? = null, top: Int? = null): ListPolicyFragmentReferencesResult
Link copied to clipboard

Gets the specified Subscription keys. API Version: 2020-12-01.

suspend fun listSubscriptionSecrets(resourceGroupName: String, serviceName: String, sid: String): ListSubscriptionSecretsResult
Link copied to clipboard

Gets the Git access configuration for the tenant. API Version: 2019-12-01.

suspend fun listTenantAccessGitSecrets(accessName: String, resourceGroupName: String, serviceName: String): ListTenantAccessGitSecretsResult
Link copied to clipboard

Get tenant access information details. API Version: 2020-12-01.

suspend fun listTenantAccessSecrets(accessName: String, resourceGroupName: String, serviceName: String): ListTenantAccessSecretsResult