{ "swagger": "2.0", "info": { "title": "Microsoft.AwsConnector", "version": "2024-12-01", "description": "Microsoft.AwsConnector Resource Provider management API.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "AccessAnalyzerAnalyzers" } ], "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/accessAnalyzerAnalyzers": { "get": { "operationId": "AccessAnalyzerAnalyzers_ListBySubscription", "tags": [ "AccessAnalyzerAnalyzers" ], "description": "List AccessAnalyzerAnalyzer resources by subscription ID", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AccessAnalyzerAnalyzerListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "AccessAnalyzerAnalyzers_ListBySubscription": { "$ref": "./examples/AccessAnalyzerAnalyzers_ListBySubscription.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/accessAnalyzerAnalyzers": { "get": { "operationId": "AccessAnalyzerAnalyzers_ListByResourceGroup", "tags": [ "AccessAnalyzerAnalyzers" ], "description": "List AccessAnalyzerAnalyzer resources by resource group", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AccessAnalyzerAnalyzerListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "AccessAnalyzerAnalyzers_ListByResourceGroup": { "$ref": "./examples/AccessAnalyzerAnalyzers_ListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/accessAnalyzerAnalyzers/{name}": { "get": { "operationId": "AccessAnalyzerAnalyzers_Get", "tags": [ "AccessAnalyzerAnalyzers" ], "description": "Get a AccessAnalyzerAnalyzer", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of AccessAnalyzerAnalyzer", "required": true, "type": "string", "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AccessAnalyzerAnalyzer" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "AccessAnalyzerAnalyzers_Get": { "$ref": "./examples/AccessAnalyzerAnalyzers_Get.json" } } }, "put": { "operationId": "AccessAnalyzerAnalyzers_CreateOrReplace", "tags": [ "AccessAnalyzerAnalyzers" ], "description": "Create a AccessAnalyzerAnalyzer. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of AccessAnalyzerAnalyzer", "required": true, "type": "string", "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/AccessAnalyzerAnalyzer" } } ], "responses": { "200": { "description": "Resource 'AccessAnalyzerAnalyzer' update operation succeeded", "schema": { "$ref": "#/definitions/AccessAnalyzerAnalyzer" } }, "201": { "description": "Resource 'AccessAnalyzerAnalyzer' create operation succeeded", "schema": { "$ref": "#/definitions/AccessAnalyzerAnalyzer" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "AccessAnalyzerAnalyzers_CreateOrReplace": { "$ref": "./examples/AccessAnalyzerAnalyzers_CreateOrReplace.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "AccessAnalyzerAnalyzers_Update", "tags": [ "AccessAnalyzerAnalyzers" ], "description": "Update a AccessAnalyzerAnalyzer", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of AccessAnalyzerAnalyzer", "required": true, "type": "string", "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/AccessAnalyzerAnalyzerTagsUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AccessAnalyzerAnalyzer" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "AccessAnalyzerAnalyzers_Update": { "$ref": "./examples/AccessAnalyzerAnalyzers_Update.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "AccessAnalyzerAnalyzers_Delete", "tags": [ "AccessAnalyzerAnalyzers" ], "description": "Delete a AccessAnalyzerAnalyzer", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of AccessAnalyzerAnalyzer", "required": true, "type": "string", "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "AccessAnalyzerAnalyzers_Delete": { "$ref": "./examples/AccessAnalyzerAnalyzers_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } } }, "definitions": { "AccessAnalyzerAnalyzer": { "type": "object", "description": "A Microsoft.AwsConnector resource", "properties": { "properties": { "$ref": "#/definitions/AccessAnalyzerAnalyzerProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, "AccessAnalyzerAnalyzerListResult": { "type": "object", "description": "The response of a AccessAnalyzerAnalyzer list operation.", "properties": { "value": { "type": "array", "description": "The AccessAnalyzerAnalyzer items on this page", "items": { "$ref": "#/definitions/AccessAnalyzerAnalyzer" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "AccessAnalyzerAnalyzerProperties": { "type": "object", "description": "Definition of AccessAnalyzerAnalyzer", "properties": { "awsProperties": { "$ref": "#/definitions/AwsAccessAnalyzerAnalyzerProperties", "description": "AWS Properties" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsTags": { "type": "object", "description": "AWS Tags", "additionalProperties": { "type": "string" } }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation.", "readOnly": true } } }, "AccessAnalyzerAnalyzerTagsUpdate": { "type": "object", "description": "The type used for updating tags in AccessAnalyzerAnalyzer resources.", "properties": { "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" } } } }, "ArchiveRule": { "type": "object", "description": "Definition of ArchiveRule", "properties": { "filter": { "type": "array", "description": "Property filter", "items": { "$ref": "#/definitions/Filter" }, "x-ms-identifiers": [] }, "ruleName": { "type": "string", "description": "The archive rule name" } } }, "AwsAccessAnalyzerAnalyzerProperties": { "type": "object", "description": "Definition of awsAccessAnalyzerAnalyzer", "properties": { "analyzerConfiguration": { "$ref": "#/definitions/UnusedAccessConfiguration", "description": "The configuration for the analyzer" }, "analyzerName": { "type": "string", "description": "Analyzer name" }, "archiveRules": { "type": "array", "description": "Property archiveRules", "items": { "$ref": "#/definitions/ArchiveRule" }, "x-ms-identifiers": [] }, "arn": { "type": "string", "description": "Amazon Resource Name (ARN) of the analyzer" }, "tags": { "type": "array", "description": "An array of key-value pairs to apply to this resource.", "items": { "$ref": "#/definitions/Tag" }, "x-ms-identifiers": [] }, "type": { "type": "string", "description": "The type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS or ORGANIZATION_UNUSED_ACCESS" } } }, "Filter": { "type": "object", "description": "Definition of Filter", "properties": { "contains": { "type": "array", "description": "Property contains", "items": { "type": "string" } }, "eq": { "type": "array", "description": "Property eq", "items": { "type": "string" } }, "exists": { "type": "boolean", "description": "Property exists" }, "neq": { "type": "array", "description": "Property neq", "items": { "type": "string" } }, "property": { "type": "string", "description": "Property property" } } }, "ProvisioningState": { "type": "string", "description": "The provisioning state of a resource.", "enum": [ "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted" ], "x-ms-enum": { "name": "ProvisioningState", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Resource has been created." }, { "name": "Failed", "value": "Failed", "description": "Resource creation failed." }, { "name": "Canceled", "value": "Canceled", "description": "Resource creation was canceled." }, { "name": "Provisioning", "value": "Provisioning", "description": "The resource is being provisioned" }, { "name": "Updating", "value": "Updating", "description": "The resource is updating" }, { "name": "Deleting", "value": "Deleting", "description": "The resource is being deleted" }, { "name": "Accepted", "value": "Accepted", "description": "The resource create request has been accepted" } ] }, "readOnly": true }, "Tag": { "type": "object", "description": "Definition of Tag", "properties": { "key": { "type": "string", "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." }, "value": { "type": "string", "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." } } }, "UnusedAccessConfiguration": { "type": "object", "description": "Definition of UnusedAccessConfiguration", "properties": { "unusedAccessAge": { "type": "integer", "format": "int32", "description": "The specified access age in days for which to generate findings for unused access. For example, if you specify 90 days, the analyzer will generate findings for IAM entities within the accounts of the selected organization for any access that hasn't been used in 90 or more days since the analyzer's last scan. You can choose a value between 1 and 180 days." } } } }, "parameters": {} }